FileManagerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FileManagerComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for FileManager component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef FILEMANAGER_COMP_HPP_
#define FILEMANAGER_COMP_HPP_
 
#include <FpConfig.hpp>
#include <Fw/Port/InputSerializePort.hpp>
#include <Fw/Port/OutputSerializePort.hpp>
#include <Fw/Comp/ActiveComponentBase.hpp>
#include <Fw/Cmd/CmdString.hpp>
#include <Fw/Tlm/TlmString.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogString.hpp>
#include <Fw/Cmd/CmdArgBuffer.hpp>
#include <Fw/Log/LogBuffer.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Tlm/TlmBuffer.hpp>
#include <Fw/Log/TextLogString.hpp>
#include <Fw/Cmd/CmdPortAc.hpp>
#include <Fw/Cmd/CmdRegPortAc.hpp>
#include <Fw/Cmd/CmdResponsePortAc.hpp>
#include <Fw/Log/LogPortAc.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Tlm/TlmPortAc.hpp>
#include <Svc/Ping/PingPortAc.hpp>
#if FW_ENABLE_TEXT_LOGGING == 1
#include <Fw/Log/LogTextPortAc.hpp>
#endif
 
namespace Svc {
 
  class FileManagerComponentBase :
    public Fw::ActiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class FileManagerComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputCmdPort* get_cmdIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Svc::InputPingPort* get_pingIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect typed input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_cmdRegOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputCmdRegPort *port 
    );
 
    void set_cmdResponseOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputCmdResponsePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogPort *port 
    );
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTimePort *port 
    );
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTlmPort *port 
    );
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Svc::InputPingPort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_LogText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogTextPort *port 
    );
#endif
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_cmdRegOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_cmdResponseOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_LogText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
#endif
 
#endif
 
  public:
 
    // ----------------------------------------------------------------------
    // Command registration
    // ----------------------------------------------------------------------
 
    void regCommands(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    FileManagerComponentBase(
        const char* compName 
    );
#else
    FileManagerComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE queueDepth, 
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~FileManagerComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual void pingIn_handler(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    ) = 0;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Port handler base-class functions for typed input ports.
    // ----------------------------------------------------------------------
    // Call these functions directly to bypass the corresponding ports.
    // ----------------------------------------------------------------------
 
    void pingIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Pre-message hooks for typed async input ports.
    // ----------------------------------------------------------------------
    // Each of these functions is invoked just before processing a message
    // on the corresponding port. By default they do nothing. You can
    // override them to provide specific pre-message behavior.
    // ----------------------------------------------------------------------
 
    virtual void pingIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Invocation functions for typed output ports
    // ----------------------------------------------------------------------
 
    void pingOut_out(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of input ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_cmdIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingIn_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_CMDIN_INPUT_PORTS = 1,
       NUM_PINGIN_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_cmdRegOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_cmdResponseOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_eventOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_timeCaller_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_tlmOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingOut_OutputPorts(void);
 
#if FW_ENABLE_TEXT_LOGGING == 1
    NATIVE_INT_TYPE getNum_LogText_OutputPorts(void);
#endif
 
 
    enum {
       NUM_CMDREGOUT_OUTPUT_PORTS = 1,
       NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
       NUM_EVENTOUT_OUTPUT_PORTS = 1,
       NUM_TIMECALLER_OUTPUT_PORTS = 1,
       NUM_TLMOUT_OUTPUT_PORTS = 1,
       NUM_PINGOUT_OUTPUT_PORTS = 1,
       NUM_LOGTEXT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_cmdRegOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_cmdResponseOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    bool isConnected_LogText_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command opcodes
    // ----------------------------------------------------------------------
 
    enum {
      OPCODE_CREATEDIRECTORY = 0x0, /* Create a directory */
      OPCODE_MOVEFILE = 0x1, /* Move a file */
      OPCODE_REMOVEDIRECTORY = 0x2, /* Remove a directory, which must be empty */
      OPCODE_REMOVEFILE = 0x3, /* Remove a file */
      OPCODE_SHELLCOMMAND = 0x4, /* Perform a Linux shell command and write the output to a log file. */
      OPCODE_APPENDFILE = 0x5, /* Append 1 file's contents to the end of another. */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command handlers to implement
    // ----------------------------------------------------------------------
 
    /* Create a directory */
    virtual void CreateDirectory_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& dirName 
    ) = 0;
 
    /* Move a file */
    virtual void MoveFile_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& sourceFileName, 
        const Fw::CmdStringArg& destFileName 
    ) = 0;
 
    /* Remove a directory, which must be empty */
    virtual void RemoveDirectory_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& dirName 
    ) = 0;
 
    /* Remove a file */
    virtual void RemoveFile_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& fileName 
    ) = 0;
 
    /* Perform a Linux shell command and write the output to a log file. */
    virtual void ShellCommand_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& command, 
        const Fw::CmdStringArg& logFileName 
    ) = 0;
 
    /* Append 1 file's contents to the end of another. */
    virtual void AppendFile_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& source, 
        const Fw::CmdStringArg& target 
    ) = 0;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Pre-message hooks for async commands.
    // ----------------------------------------------------------------------
    // Each of these functions is invoked just before processing the
    // corresponding command. By default they do nothing. You can
    // override them to provide specific pre-command behavior.
    // ----------------------------------------------------------------------
 
    virtual void CreateDirectory_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void MoveFile_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void RemoveDirectory_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void RemoveFile_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void ShellCommand_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void AppendFile_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command handler base-class functions.
    // Call these functions directly to bypass the command input port.
    // ----------------------------------------------------------------------
 
    void CreateDirectory_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void MoveFile_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void RemoveDirectory_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void RemoveFile_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void ShellCommand_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void AppendFile_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command response
    // ----------------------------------------------------------------------
 
    void cmdResponse_out(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CommandResponse response 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event IDs
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_DIRECTORYCREATEERROR = 0x0, /* An error occurred while attempting to create a directory */
      EVENTID_DIRECTORYREMOVEERROR = 0x1, /* An error occurred while attempting to remove a directory */
      EVENTID_FILEMOVEERROR = 0x2, /* An error occurred while attempting to move a file */
      EVENTID_FILEREMOVEERROR = 0x3, /* An error occurred while attempting to remove a file */
      EVENTID_SHELLCOMMANDFAILED = 0x4, /* The File System component executed a shell command that returned status non-zero */
      EVENTID_APPENDFILEFAILED = 0x5, /* The File System component returned status non-zero when trying to append 2 files together */
      EVENTID_APPENDFILESUCCEEDED = 0x6, /* The File System component appended 2 files without error */
      EVENTID_SHELLCOMMANDSUCCEEDED = 0x7, /* The File System component executed a shell command that returned status zero */
      EVENTID_CREATEDIRECTORYSUCCEEDED = 0x8, /* The File System component created a new directory without error */
      EVENTID_REMOVEDIRECTORYSUCCEEDED = 0x9, /* The File System component deleted and existing directory without error */
      EVENTID_MOVEFILESUCCEEDED = 0xA, /* The File System component moved a file to a new location without error */
      EVENTID_REMOVEFILESUCCEEDED = 0xB, /* The File System component deleted an existing file without error */
      EVENTID_APPENDFILESTARTED = 0xC, /* The File System component appended 2 files without error */
      EVENTID_SHELLCOMMANDSTARTED = 0xD, /* The File System component began executing a shell command */
      EVENTID_CREATEDIRECTORYSTARTED = 0xE, /* The File System component began creating a new directory */
      EVENTID_REMOVEDIRECTORYSTARTED = 0xF, /* The File System component began deleting a directory */
      EVENTID_MOVEFILESTARTED = 0x10, /* The File System component began moving a file to a new location */
      EVENTID_REMOVEFILESTARTED = 0x11, /* The File System component began deleting an existing file */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
    /* An error occurred while attempting to create a directory */
    void log_WARNING_HI_DirectoryCreateError(
        Fw::LogStringArg& dirName, 
        U32 status 
    );
 
 
    /* An error occurred while attempting to remove a directory */
    void log_WARNING_HI_DirectoryRemoveError(
        Fw::LogStringArg& dirName, 
        U32 status 
    );
 
 
    /* An error occurred while attempting to move a file */
    void log_WARNING_HI_FileMoveError(
        Fw::LogStringArg& sourceFileName, 
        Fw::LogStringArg& destFileName, 
        U32 status 
    );
 
 
    /* An error occurred while attempting to remove a file */
    void log_WARNING_HI_FileRemoveError(
        Fw::LogStringArg& fileName, 
        U32 status 
    );
 
 
    /* The File System component executed a shell command that returned status non-zero */
    void log_WARNING_HI_ShellCommandFailed(
        Fw::LogStringArg& command, 
        U32 status 
    );
 
 
    /* The File System component returned status non-zero when trying to append 2 files together */
    void log_WARNING_HI_AppendFileFailed(
        Fw::LogStringArg& source, 
        Fw::LogStringArg& target, 
        U32 status 
    );
 
 
    /* The File System component appended 2 files without error */
    void log_ACTIVITY_HI_AppendFileSucceeded(
        Fw::LogStringArg& source, 
        Fw::LogStringArg& target 
    );
 
 
    /* The File System component executed a shell command that returned status zero */
    void log_ACTIVITY_HI_ShellCommandSucceeded(
        Fw::LogStringArg& command 
    );
 
 
    /* The File System component created a new directory without error */
    void log_ACTIVITY_HI_CreateDirectorySucceeded(
        Fw::LogStringArg& dirName 
    );
 
 
    /* The File System component deleted and existing directory without error */
    void log_ACTIVITY_HI_RemoveDirectorySucceeded(
        Fw::LogStringArg& dirName 
    );
 
 
    /* The File System component moved a file to a new location without error */
    void log_ACTIVITY_HI_MoveFileSucceeded(
        Fw::LogStringArg& sourceFileName, 
        Fw::LogStringArg& destFileName 
    );
 
 
    /* The File System component deleted an existing file without error */
    void log_ACTIVITY_HI_RemoveFileSucceeded(
        Fw::LogStringArg& fileName 
    );
 
 
    /* The File System component appended 2 files without error */
    void log_ACTIVITY_HI_AppendFileStarted(
        Fw::LogStringArg& source, 
        Fw::LogStringArg& target 
    );
 
 
    /* The File System component began executing a shell command */
    void log_ACTIVITY_HI_ShellCommandStarted(
        Fw::LogStringArg& command 
    );
 
 
    /* The File System component began creating a new directory */
    void log_ACTIVITY_HI_CreateDirectoryStarted(
        Fw::LogStringArg& dirName 
    );
 
 
    /* The File System component began deleting a directory */
    void log_ACTIVITY_HI_RemoveDirectoryStarted(
        Fw::LogStringArg& dirName 
    );
 
 
    /* The File System component began moving a file to a new location */
    void log_ACTIVITY_HI_MoveFileStarted(
        Fw::LogStringArg& sourceFileName, 
        Fw::LogStringArg& destFileName 
    );
 
 
    /* The File System component began deleting an existing file */
    void log_ACTIVITY_HI_RemoveFileStarted(
        Fw::LogStringArg& fileName 
    );
 
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Channel IDs
    // ----------------------------------------------------------------------
 
    enum {
      CHANNELID_COMMANDSEXECUTED = 0x0, 
      CHANNELID_ERRORS = 0x1, 
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Telemetry write functions
    // ----------------------------------------------------------------------
 
    /* The total number of commands successfully executed */
    void tlmWrite_CommandsExecuted(
        U32 arg 
    );
 
    /* The total number of errors */
    void tlmWrite_Errors(
        U32 arg 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Time
    // ----------------------------------------------------------------------
 
    Fw::Time getTime(void);
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];
 
    Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];
 
    Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];
 
    Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];
 
    Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
 
    Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
 
    Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
 
#if FW_ENABLE_TEXT_LOGGING == 1
    Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];
#endif
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Calls for messages received on typed input ports
    // ----------------------------------------------------------------------
 
    static void m_p_cmdIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    static void m_p_pingIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Message dispatch functions
    // ----------------------------------------------------------------------
 
    virtual MsgDispatchStatus doDispatch(void);
 
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Counter values for event throttling
    // ----------------------------------------------------------------------
 
  };
 
} // end namespace Svc
#endif