BufferLoggerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferLoggerComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for BufferLogger component base class
// ======================================================================
 
#ifndef Svc_BufferLoggerComponentAc_HPP
#define Svc_BufferLoggerComponentAc_HPP
 
#include "FpConfig.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#include "Fw/Com/ComPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.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/BufferLogger/BufferLogger_LogStateEnumAc.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
 
namespace Svc {
 
  class BufferLoggerComponentBase :
    public Fw::ActiveComponentBase
  {
 
      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------
 
      friend class BufferLoggerComponentBaseFriend;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------
 
      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };
 
      enum {
        NUM_BUFFERSENDIN_INPUT_PORTS = 1,
        NUM_COMIN_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
        NUM_SCHEDIN_INPUT_PORTS = 1,
      };
 
      enum {
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };
 
      enum {
        NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1,
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };
 
      enum {
        OPCODE_BL_OPENFILE = 0x0, 
        OPCODE_BL_CLOSEFILE = 0x1, 
        OPCODE_BL_SETLOGGING = 0x2, 
        OPCODE_BL_FLUSHFILE = 0x3, 
      };
 
      enum {
        EVENTID_BL_LOGFILECLOSED = 0x0, 
        EVENTID_BL_LOGFILEOPENERROR = 0x1, 
        EVENTID_BL_LOGFILEVALIDATIONERROR = 0x2, 
        EVENTID_BL_LOGFILEWRITEERROR = 0x3, 
        EVENTID_BL_ACTIVATED = 0x4, 
        EVENTID_BL_DEACTIVATED = 0x5, 
        EVENTID_BL_NOLOGFILEOPENINITERROR = 0x6, 
      };
 
      enum {
        CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0x0, 
      };
 
    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
      // ----------------------------------------------------------------------
 
      Fw::InputBufferSendPort* get_bufferSendIn_InputPort(
          FwIndexType portNum 
      );
 
      Fw::InputComPort* get_comIn_InputPort(
          FwIndexType portNum 
      );
 
      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );
 
      Svc::InputSchedPort* get_schedIn_InputPort(
          FwIndexType portNum 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------
 
      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 
      );
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      void set_eventOutText_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );
 
#endif
 
      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_bufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputPingPort* port 
      );
 
#if FW_PORT_SERIALIZATION
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------
 
      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 
      );
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      void set_eventOutText_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
      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_bufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
    public:
 
      // ----------------------------------------------------------------------
      // Command registration
      // ----------------------------------------------------------------------
 
      void regCommands();
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------
 
      BufferLoggerComponentBase(
          const char* compName = "" 
      );
 
      virtual ~BufferLoggerComponentBase();
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of special input ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_cmdIn_InputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_bufferSendIn_InputPorts() const;
 
      FwIndexType getNum_comIn_InputPorts() const;
 
      FwIndexType getNum_pingIn_InputPorts() const;
 
      FwIndexType getNum_schedIn_InputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_cmdRegOut_OutputPorts() const;
 
      FwIndexType getNum_cmdResponseOut_OutputPorts() const;
 
      FwIndexType getNum_eventOut_OutputPorts() const;
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      FwIndexType getNum_eventOutText_OutputPorts() const;
 
#endif
 
      FwIndexType getNum_timeCaller_OutputPorts() const;
 
      FwIndexType getNum_tlmOut_OutputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_bufferSendOut_OutputPorts() const;
 
      FwIndexType getNum_pingOut_OutputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------
 
      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_eventOut_OutputPort(
          FwIndexType portNum 
      );
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      bool isConnected_eventOutText_OutputPort(
          FwIndexType portNum 
      );
 
#endif
 
      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------
 
      bool isConnected_bufferSendOut_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------
 
      virtual void bufferSendIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;
 
      virtual void comIn_handler(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      ) = 0;
 
      virtual void pingIn_handler(
          FwIndexType portNum, 
          U32 key 
      ) = 0;
 
      virtual void schedIn_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------
 
      void bufferSendIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      void comIn_handlerBase(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      void pingIn_handlerBase(
          FwIndexType portNum, 
          U32 key 
      );
 
      void schedIn_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );
 
    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 bufferSendIn_preMsgHook(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      virtual void comIn_preMsgHook(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      virtual void pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );
 
      virtual void schedIn_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------
 
      void bufferSendOut_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      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 BL_OpenFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& file
      ) = 0;
 
      virtual void BL_CloseFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;
 
      virtual void BL_SetLogging_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::BufferLogger_LogState state
      ) = 0;
 
      virtual void BL_FlushFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Command handler base-class functions
      //
      // Call these functions directly to bypass the command input port
      // ----------------------------------------------------------------------
 
      void BL_OpenFile_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );
 
      void BL_CloseFile_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );
 
      void BL_SetLogging_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );
 
      void BL_FlushFile_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 BL_OpenFile_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );
 
      virtual void BL_CloseFile_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );
 
      virtual void BL_SetLogging_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );
 
      virtual void BL_FlushFile_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------
 
      void log_DIAGNOSTIC_BL_LogFileClosed(
          const Fw::StringBase& file 
      ) const;
 
      void log_WARNING_HI_BL_LogFileOpenError(
          U32 errornum, 
          const Fw::StringBase& file 
      ) const;
 
      void log_WARNING_HI_BL_LogFileValidationError(
          const Fw::StringBase& validationFile, 
          U32 status 
      ) const;
 
      void log_WARNING_HI_BL_LogFileWriteError(
          U32 errornum, 
          U32 bytesWritten, 
          U32 bytesToWrite, 
          const Fw::StringBase& file 
      ) const;
 
      void log_ACTIVITY_LO_BL_Activated() const;
 
      void log_ACTIVITY_LO_BL_Deactivated() const;
 
      void log_WARNING_HI_BL_NoLogFileOpenInitError() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------
 
      void tlmWrite_BufferLogger_NumLoggedBuffers(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------
 
      Fw::Time getTime();
 
    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_bufferSendIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      static void m_p_comIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      static void m_p_pingIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 key 
      );
 
      static void m_p_schedIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Special input ports
      // ----------------------------------------------------------------------
 
      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];
 
      Fw::InputComPort m_comIn_InputPort[NUM_COMIN_INPUT_PORTS];
 
      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
 
      Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Special 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];
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      Fw::OutputLogTextPort m_eventOutText_OutputPort[NUM_EVENTOUTTEXT_OUTPUT_PORTS];
 
#endif
 
      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
 
      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------
 
      Fw::OutputBufferSendPort m_bufferSendOut_OutputPort[NUM_BUFFERSENDOUT_OUTPUT_PORTS];
 
      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
 
  };
 
}
 
#endif