FileManagerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FileManagerComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for FileManager component base class
// ======================================================================

#ifndef Svc_FileManagerComponentAc_HPP
#define Svc_FileManagerComponentAc_HPP

#include <atomic>

#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Svc/Ping/PingPortAc.hpp"

namespace Svc {

  class FileManagerComponentBase :
    public Fw::ActiveComponentBase
  {

      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------

      friend class FileManagerComponentBaseFriend;
      friend class FileManagerTesterBase;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_PINGIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        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,
      };

      enum {
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_CREATEDIRECTORY = 0x0, 
        OPCODE_MOVEFILE = 0x1, 
        OPCODE_REMOVEDIRECTORY = 0x2, 
        OPCODE_REMOVEFILE = 0x3, 
        OPCODE_SHELLCOMMAND = 0x4, 
        OPCODE_APPENDFILE = 0x5, 
        OPCODE_FILESIZE = 0x6,
      };

      enum {
        EVENTID_DIRECTORYCREATEERROR = 0x0, 
        EVENTID_DIRECTORYREMOVEERROR = 0x1, 
        EVENTID_FILEMOVEERROR = 0x2, 
        EVENTID_FILEREMOVEERROR = 0x3, 
        EVENTID_SHELLCOMMANDFAILED = 0x4, 
        EVENTID_APPENDFILEFAILED = 0x5, 
        EVENTID_APPENDFILESUCCEEDED = 0x6, 
        EVENTID_SHELLCOMMANDSUCCEEDED = 0x7, 
        EVENTID_CREATEDIRECTORYSUCCEEDED = 0x8, 
        EVENTID_REMOVEDIRECTORYSUCCEEDED = 0x9, 
        EVENTID_MOVEFILESUCCEEDED = 0xa, 
        EVENTID_REMOVEFILESUCCEEDED = 0xb, 
        EVENTID_APPENDFILESTARTED = 0xc, 
        EVENTID_SHELLCOMMANDSTARTED = 0xd, 
        EVENTID_CREATEDIRECTORYSTARTED = 0xe, 
        EVENTID_REMOVEDIRECTORYSTARTED = 0xf, 
        EVENTID_MOVEFILESTARTED = 0x10, 
        EVENTID_REMOVEFILESTARTED = 0x11, 
        EVENTID_FILESIZESUCCEEDED = 0x12, 
        EVENTID_FILESIZEERROR = 0x13, 
        EVENTID_FILESIZESTARTED = 0x14, 
      };

      enum {
        CHANNELID_COMMANDSEXECUTED = 0x0, 
        CHANNELID_ERRORS = 0x1, 
      };

    public:

      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------

      void init(
          FwSizeType queueDepth, 
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort* get_cmdIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdRegPort* port 
      );

      void set_cmdResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

      void set_eventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputPingPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_cmdResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_eventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Command registration
      // ----------------------------------------------------------------------

      void regCommands();

    PROTECTED:

      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------

      FileManagerComponentBase(
          const char* compName = "" 
      );

      virtual ~FileManagerComponentBase();

    PROTECTED:

      // ----------------------------------------------------------------------
      // Getters for numbers of special input ports
      // ----------------------------------------------------------------------

      FwIndexType getNum_cmdIn_InputPorts() const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      FwIndexType getNum_pingIn_InputPorts() const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      FwIndexType getNum_LogText_OutputPorts() const;

#endif

      FwIndexType getNum_cmdRegOut_OutputPorts() const;

      FwIndexType getNum_cmdResponseOut_OutputPorts() const;

      FwIndexType getNum_eventOut_OutputPorts() const;

      FwIndexType getNum_timeCaller_OutputPorts() const;

      FwIndexType getNum_tlmOut_OutputPorts() const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------

      FwIndexType getNum_pingOut_OutputPorts() const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_eventOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual void pingIn_handler(
          FwIndexType 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(
          FwIndexType 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(
          FwIndexType portNum, 
          U32 key 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------

      void pingOut_out(
          FwIndexType portNum, 
          U32 key 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Command response
      // ----------------------------------------------------------------------

      void cmdResponse_out(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdResponse response 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Command handlers to implement
      // ----------------------------------------------------------------------

      virtual void CreateDirectory_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& dirName 
      ) = 0;

      virtual void MoveFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& sourceFileName, 
          const Fw::CmdStringArg& destFileName 
      ) = 0;

      virtual void RemoveDirectory_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& dirName 
      ) = 0;

      virtual void RemoveFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& fileName, 
          bool ignoreErrors 
      ) = 0;

      virtual void ShellCommand_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& command, 
          const Fw::CmdStringArg& logFileName 
      ) = 0;

      virtual void AppendFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& source, 
          const Fw::CmdStringArg& target 
      ) = 0;

      virtual void FileSize_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& fileName 
      ) = 0;

    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 
      );

      void FileSize_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    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 
      );

      virtual void FileSize_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_DirectoryCreateError(
          const Fw::StringBase& dirName, 
          U32 status 
      ) const;

      void log_WARNING_HI_DirectoryRemoveError(
          const Fw::StringBase& dirName, 
          U32 status 
      ) const;

      void log_WARNING_HI_FileMoveError(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName, 
          U32 status 
      ) const;

      void log_WARNING_HI_FileRemoveError(
          const Fw::StringBase& fileName, 
          U32 status 
      ) const;

      void log_WARNING_HI_ShellCommandFailed(
          const Fw::StringBase& command, 
          U32 status 
      ) const;

      void log_WARNING_HI_AppendFileFailed(
          const Fw::StringBase& source, 
          const Fw::StringBase& target, 
          U32 status 
      ) const;

      void log_ACTIVITY_HI_AppendFileSucceeded(
          const Fw::StringBase& source, 
          const Fw::StringBase& target 
      ) const;

      void log_ACTIVITY_HI_ShellCommandSucceeded(
          const Fw::StringBase& command 
      ) const;

      void log_ACTIVITY_HI_CreateDirectorySucceeded(
          const Fw::StringBase& dirName 
      ) const;

      void log_ACTIVITY_HI_RemoveDirectorySucceeded(
          const Fw::StringBase& dirName 
      ) const;

      void log_ACTIVITY_HI_MoveFileSucceeded(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

      void log_ACTIVITY_HI_RemoveFileSucceeded(
          const Fw::StringBase& fileName 
      ) const;

      void log_ACTIVITY_HI_AppendFileStarted(
          const Fw::StringBase& source, 
          const Fw::StringBase& target 
      ) const;

      void log_ACTIVITY_HI_ShellCommandStarted(
          const Fw::StringBase& command 
      ) const;

      void log_ACTIVITY_HI_CreateDirectoryStarted(
          const Fw::StringBase& dirName 
      ) const;

      void log_ACTIVITY_HI_RemoveDirectoryStarted(
          const Fw::StringBase& dirName 
      ) const;

      void log_ACTIVITY_HI_MoveFileStarted(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

      void log_ACTIVITY_HI_RemoveFileStarted(
          const Fw::StringBase& fileName 
      ) const;

      void log_ACTIVITY_HI_FileSizeSucceeded(
          const Fw::StringBase& fileName, 
          U64 size 
      ) const;

      void log_WARNING_HI_FileSizeError(
          const Fw::StringBase& fileName, 
          U32 status 
      ) const;

      void log_ACTIVITY_HI_FileSizeStarted(
          const Fw::StringBase& fileName 
      ) const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_CommandsExecuted(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_Errors(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------

      Fw::Time getTime() const;

    PRIVATE:

      // ----------------------------------------------------------------------
      // Message dispatch functions
      // ----------------------------------------------------------------------

      virtual MsgDispatchStatus doDispatch();

    PRIVATE:

      // ----------------------------------------------------------------------
      // Calls for messages received on special input ports
      // ----------------------------------------------------------------------

      static void m_p_cmdIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    PRIVATE:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static void m_p_pingIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 key 
      );

    PRIVATE:

      // ----------------------------------------------------------------------
      // Special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

    PRIVATE:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

    PRIVATE:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];

#endif

      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];

    PRIVATE:

      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

  };

}

#endif