TlmPacketizerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_TlmPacketizerComponentAc_HPP
#define Svc_TlmPacketizerComponentAc_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/Com/ComPortAc.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/TlmGetPortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Fw/Types/EnabledEnumAc.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Ports/TlmPacketizerPorts/EnableSectionPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_GroupConfigSerializableAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_GroupConfigsArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_RateLogicEnumAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_SectionConfigsArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_SectionEnabledArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_TelemetrySendSectionArrayAc.hpp"
#include "default/config/FwChanIdTypeAliasAc.hpp"
#include "default/config/FwIndexTypeAliasAc.hpp"
#include "default/config/TelemetrySectionEnumAc.hpp"

namespace Svc {

  class TlmPacketizerComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class TlmPacketizerTesterBase;
      friend class TlmPacketizerTester;

    protected:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_RUN_INPUT_PORTS = 1,
        NUM_TLMGET_INPUT_PORTS = 1,
        NUM_TLMRECV_INPUT_PORTS = 1,
        NUM_CONTROLIN_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMEGETOUT_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_PKTSEND_OUTPUT_PORTS = 3,
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_SET_LEVEL = 0x0, 
        OPCODE_SEND_PKT = 0x1, 
        OPCODE_ENABLE_SECTION = 0x2, 
        OPCODE_ENABLE_GROUP = 0x3, 
        OPCODE_FORCE_GROUP = 0x4, 
        OPCODE_CONFIGURE_GROUP_RATES = 0x5, 
      };

      enum {
        EVENTID_NOCHAN = 0x0, 
        EVENTID_LEVELSET = 0x1, 
        EVENTID_MAXLEVELEXCEED = 0x2, 
        EVENTID_PACKETSENT = 0x3, 
        EVENTID_PACKETNOTFOUND = 0x4, 
        EVENTID_SECTIONUNCONFIGURABLE = 0x5,
      };

      enum {
        CHANNELID_GROUPCONFIGS = 0x0, 
        CHANNELID_SECTIONENABLED = 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::InputSchedPort* get_Run_InputPort(
          FwIndexType portNum 
      );

      Fw::InputTlmGetPort* get_TlmGet_InputPort(
          FwIndexType portNum 
      );

      Fw::InputTlmPort* get_TlmRecv_InputPort(
          FwIndexType portNum 
      );

      Svc::InputEnableSectionPort* get_controlIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_pingIn_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_textEventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_timeGetOut_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_PktSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* 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_textEventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_timeGetOut_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_PktSend_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
      // ----------------------------------------------------------------------

      TlmPacketizerComponentBase(
          const char* compName = "" 
      );

      virtual ~TlmPacketizerComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_cmdIn_InputPorts() {
        return NUM_CMDIN_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_Run_InputPorts() {
        return NUM_RUN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_TlmGet_InputPorts() {
        return NUM_TLMGET_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_TlmRecv_InputPorts() {
        return NUM_TLMRECV_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_controlIn_InputPorts() {
        return NUM_CONTROLIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingIn_InputPorts() {
        return NUM_PINGIN_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_cmdRegOut_OutputPorts() {
        return NUM_CMDREGOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_cmdResponseOut_OutputPorts() {
        return NUM_CMDRESPONSEOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_eventOut_OutputPorts() {
        return NUM_EVENTOUT_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_textEventOut_OutputPorts() {
        return NUM_TEXTEVENTOUT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_timeGetOut_OutputPorts() {
        return NUM_TIMEGETOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_tlmOut_OutputPorts() {
        return NUM_TLMOUT_OUTPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_PktSend_OutputPorts() {
        return NUM_PKTSEND_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingOut_OutputPorts() {
        return NUM_PINGOUT_OUTPUT_PORTS;
      }

    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_textEventOut_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_timeGetOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      bool isConnected_PktSend_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void Run_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

      virtual Fw::TlmValid TlmGet_handler(
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      ) = 0;

      virtual void TlmRecv_handler(
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      ) = 0;

      virtual void controlIn_handler(
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          const Fw::Enabled& enabled 
      ) = 0;

      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 Run_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

      Fw::TlmValid TlmGet_handlerBase(
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      );

      void TlmRecv_handlerBase(
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      );

      void controlIn_handlerBase(
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          const Fw::Enabled& enabled 
      );

      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 Run_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );

      virtual void controlIn_preMsgHook(
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          const Fw::Enabled& enabled 
      );

      virtual void pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

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

      void PktSend_out(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      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 SET_LEVEL_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          FwChanIdType level 
      ) = 0;

      virtual void SEND_PKT_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          U32 id, 
          Svc::TelemetrySection section 
      ) = 0;

      virtual void ENABLE_SECTION_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::TelemetrySection section, 
          Fw::Enabled enable 
      ) = 0;

      virtual void ENABLE_GROUP_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::TelemetrySection section, 
          FwChanIdType tlmGroup, 
          Fw::Enabled enable 
      ) = 0;

      virtual void FORCE_GROUP_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::TelemetrySection section, 
          FwChanIdType tlmGroup, 
          Fw::Enabled enable 
      ) = 0;

      virtual void CONFIGURE_GROUP_RATES_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::TelemetrySection section, 
          FwChanIdType tlmGroup, 
          Svc::TlmPacketizer_RateLogic rateLogic, 
          U32 minDelta, 
          U32 maxDelta 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Command handler base-class functions
      //
      // Call these functions directly to bypass the command input port
      // ----------------------------------------------------------------------

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

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

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

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

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

      void CONFIGURE_GROUP_RATES_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 SET_LEVEL_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void SEND_PKT_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void ENABLE_SECTION_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void ENABLE_GROUP_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void FORCE_GROUP_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CONFIGURE_GROUP_RATES_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

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

      void log_WARNING_LO_NoChan(
          FwChanIdType Id 
      ) const;

      void log_ACTIVITY_HI_LevelSet(
          FwChanIdType id 
      ) const;

      void log_WARNING_LO_MaxLevelExceed(
          FwChanIdType level, 
          FwChanIdType max 
      ) const;

      void log_ACTIVITY_LO_PacketSent(
          U32 id 
      ) const;

      void log_WARNING_LO_PacketNotFound(
          U32 id 
      ) const;

      void log_WARNING_LO_SectionUnconfigurable(
          Svc::TelemetrySection section, 
          Fw::Enabled enable 
      ) const;

    protected:

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

      void tlmWrite_GroupConfigs(
          const Svc::TlmPacketizer_SectionConfigs& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_SectionEnabled(
          const Svc::TlmPacketizer_SectionEnabled& 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_Run_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

      static Fw::TlmValid m_p_TlmGet_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      );

      static void m_p_TlmRecv_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      );

      static void m_p_controlIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          const Fw::Enabled& enabled 
      );

      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::InputSchedPort m_Run_InputPort[NUM_RUN_INPUT_PORTS];

      Fw::InputTlmGetPort m_TlmGet_InputPort[NUM_TLMGET_INPUT_PORTS];

      Fw::InputTlmPort m_TlmRecv_InputPort[NUM_TLMRECV_INPUT_PORTS];

      Svc::InputEnableSectionPort m_controlIn_InputPort[NUM_CONTROLIN_INPUT_PORTS];

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_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_textEventOut_OutputPort[NUM_TEXTEVENTOUT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_timeGetOut_OutputPort[NUM_TIMEGETOUT_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

    private:

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

      Fw::OutputComPort m_PktSend_OutputPort[NUM_PKTSEND_OUTPUT_PORTS];

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

  };

}

#endif