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/Buffer/BufferGetPortAc.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/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#include "Fw/Log/LogTextPortAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Prm/PrmExternalTypes.hpp"
#include "Fw/Prm/PrmGetPortAc.hpp"
#include "Fw/Prm/PrmSetPortAc.hpp"
#include "Fw/Prm/PrmString.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmGetPortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Fw/Types/DeserialStatusEnumAc.hpp"
#include "Fw/Types/EnabledEnumAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Ports/TlmPacketizerPorts/ConfigureGroupRatePortAc.hpp"
#include "Svc/Ports/TlmPacketizerPorts/EnableSectionPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "Svc/TlmPacketizer/PacketOverrideConfigSerializableAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_GroupConfigsArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_PacketOverridesArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_SectionConfigsArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_SectionEnabledArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmPacketizer_TelemetrySendSectionArrayAc.hpp"
#include "Svc/TlmPacketizer/TlmSendConfigSerializableAc.hpp"
#include "Svc/TlmPacketizer/config/TlmPacketizerConfig/TelemetrySectionEnumAc.hpp"
#include "Svc/Types/TlmPacketizerTypes/RateLogicEnumAc.hpp"
#include "Svc/Types/TlmPacketizerTypes/TlmSendStateEnumAc.hpp"
#include "default/config/FwChanIdTypeAliasAc.hpp"
#include "default/config/FwIndexTypeAliasAc.hpp"
#include "default/config/FwSizeTypeAliasAc.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_CONFIGURESECTIONGROUPRATE_INPUT_PORTS = 1,
        NUM_CONTROLIN_INPUT_PORTS = 1,
        NUM_PACKETOVERRIDEIN_INPUT_PORTS = 1,
        NUM_PACKETOVERRIDERETURNIN_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_PARAMGETOUT_OUTPUT_PORTS = 1,
        NUM_PARAMSETOUT_OUTPUT_PORTS = 1,
        NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMEGETOUT_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_PKTSEND_OUTPUT_PORTS = 2,
        NUM_ALLOCATE_OUTPUT_PORTS = 1,
        NUM_DEALLOCATE_OUTPUT_PORTS = 1,
        NUM_PACKETOVERRIDEOUT_OUTPUT_PORTS = 1,
        NUM_PACKETOVERRIDERETURNOUT_OUTPUT_PORTS = 1,
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_SET_LEVEL = 0x0, 
        OPCODE_SEND_PKT = 0x1, 
        OPCODE_ENABLE_SECTION = 0x2, 
        OPCODE_CONFIGURE_GROUP_SEND = 0x3, 
        OPCODE_CONFIGURE_GROUP_RATES = 0x4, 
        OPCODE_GET_PACKET_CONFIG = 0x5, 
        OPCODE_OVERRIDE_PACKET_SEND = 0x6, 
        OPCODE_OVERRIDE_PACKET_RATES = 0x7, 
        OPCODE_CLEAR_PACKET_OVERRIDE = 0x8, 
        OPCODE_SECTION_ENABLED_SET = 0x9, 
        OPCODE_SECTION_ENABLED_SAVE = 0xa, 
        OPCODE_SECTION_CONFIGS_SET = 0xb, 
        OPCODE_SECTION_CONFIGS_SAVE = 0xc, 
      };

      enum {
        EVENTID_NOCHAN = 0x0, 
        EVENTID_LEVELSET = 0x1, 
        EVENTID_MAXLEVELEXCEED = 0x2, 
        EVENTID_PACKETSENT = 0x3, 
        EVENTID_PACKETNOTFOUND = 0x4, 
        EVENTID_SECTIONUNCONFIGURABLE = 0x5,
        EVENTID_OVERSIZEDCHANNEL = 0x6, 
        EVENTID_RELOADRECORDUNKNOWNPACKET = 0x7, 
        EVENTID_CONFIGMIRRORALLOCFAILED = 0x8, 
        EVENTID_PACKETCONFIGREPORT = 0x9, 
        EVENTID_PACKETOVERRIDESET = 0xa, 
        EVENTID_PACKETOVERRIDECLEARED = 0xb, 
        EVENTID_CONFIGRELOADFAILED = 0xc, 
        EVENTID_INVALIDPACKETCONFIG = 0xd, 
        EVENTID_RELOADRECORDINVALID = 0xe, 
        EVENTID_GROUPSENDSTATESET = 0xf, 
      };

      enum {
        EVENTID_OVERSIZEDCHANNEL_THROTTLE = 10, 
        EVENTID_CONFIGMIRRORALLOCFAILED_THROTTLE = 10, 
      };

      enum {
        CHANNELID_GROUPCONFIGS = 0x0, 
        CHANNELID_SECTIONENABLED = 0x1, 
      };

      enum {
        PARAMID_SECTION_ENABLED = 0x0, 
        PARAMID_SECTION_CONFIGS = 0x1, 
      };

    public:

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

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

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Fw::InputCmdPort* get_cmdIn_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    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::InputConfigureGroupRatePort* get_configureSectionGroupRate_InputPort(
          FwIndexType portNum 
      );

      Svc::InputEnableSectionPort* get_controlIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_packetOverrideIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_packetOverrideReturnIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

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

      void set_paramGetOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputPrmGetPort* port 
      );

      void set_paramSetOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputPrmSetPort* 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 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

      void set_PktSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* port 
      );

      void set_allocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferGetPort* port 
      );

      void set_deallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_packetOverrideOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_packetOverrideReturnOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

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

#endif

#if !FW_DIRECT_PORT_CALLS && 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 
      );

      void set_paramSetOut_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_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

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

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

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

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

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

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

#endif

    public:

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

      void regCommands();

    public:

      // ----------------------------------------------------------------------
      // Parameter loading
      // ----------------------------------------------------------------------

      void loadParameters();

    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_configureSectionGroupRate_InputPorts() {
        return NUM_CONFIGURESECTIONGROUPRATE_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_controlIn_InputPorts() {
        return NUM_CONTROLIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_packetOverrideIn_InputPorts() {
        return NUM_PACKETOVERRIDEIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_packetOverrideReturnIn_InputPorts() {
        return NUM_PACKETOVERRIDERETURNIN_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;
      }

      static constexpr FwIndexType getNum_paramGetOut_OutputPorts() {
        return NUM_PARAMGETOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_paramSetOut_OutputPorts() {
        return NUM_PARAMSETOUT_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_allocate_OutputPorts() {
        return NUM_ALLOCATE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_deallocate_OutputPorts() {
        return NUM_DEALLOCATE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_packetOverrideOut_OutputPorts() {
        return NUM_PACKETOVERRIDEOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_packetOverrideReturnOut_OutputPorts() {
        return NUM_PACKETOVERRIDERETURNOUT_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 
      ) const;

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_eventOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_paramGetOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_paramSetOut_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_textEventOut_OutputPort(
          FwIndexType portNum 
      ) const;

#endif

      bool isConnected_timeGetOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      ) const;

    protected:

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

      bool isConnected_PktSend_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_allocate_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_deallocate_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_packetOverrideOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_packetOverrideReturnOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

      // ----------------------------------------------------------------------
      // Port handler base-class functions for special input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      void cmdIn_handlerBase(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    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 configureSectionGroupRate_handler(
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          FwChanIdType tlmGroup, 
          const Svc::RateLogic& rateLogic, 
          U32 minDelta, 
          U32 maxDelta 
      ) = 0;

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

      virtual void packetOverrideIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

      virtual void packetOverrideReturnIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

      virtual void pingIn_handler(
          FwIndexType portNum, 
          U32 key 
      ) = 0;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

      // ----------------------------------------------------------------------
      // 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 configureSectionGroupRate_handlerBase(
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          FwChanIdType tlmGroup, 
          const Svc::RateLogic& rateLogic, 
          U32 minDelta, 
          U32 maxDelta 
      );

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

      void packetOverrideIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void packetOverrideReturnIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      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 configureSectionGroupRate_preMsgHook(
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          FwChanIdType tlmGroup, 
          const Svc::RateLogic& rateLogic, 
          U32 minDelta, 
          U32 maxDelta 
      );

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

      virtual void packetOverrideIn_preMsgHook(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

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

      Fw::Buffer allocate_out(
          FwIndexType portNum, 
          FwSizeType size 
      ) const;

      void deallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) const;

      void packetOverrideOut_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) const;

      void packetOverrideReturnOut_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) const;

      void pingOut_out(
          FwIndexType portNum, 
          U32 key 
      ) const;

    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, 
          const Svc::TelemetrySection& section 
      ) = 0;

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

      virtual void CONFIGURE_GROUP_SEND_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Svc::TelemetrySection& section, 
          FwChanIdType tlmGroup, 
          const Svc::TlmSendState& sendState 
      ) = 0;

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

      virtual void GET_PACKET_CONFIG_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Svc::TelemetrySection& section, 
          U32 packetId 
      ) = 0;

      virtual void OVERRIDE_PACKET_SEND_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Svc::TelemetrySection& section, 
          U32 packetId, 
          const Svc::TlmSendState& sendState 
      ) = 0;

      virtual void OVERRIDE_PACKET_RATES_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Svc::TelemetrySection& section, 
          U32 packetId, 
          const Svc::RateLogic& rateLogic, 
          U32 minDelta, 
          U32 maxDelta 
      ) = 0;

      virtual void CLEAR_PACKET_OVERRIDE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Svc::TelemetrySection& section, 
          U32 packetId 
      ) = 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 CONFIGURE_GROUP_SEND_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

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

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

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

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

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

      virtual void CONFIGURE_GROUP_RATES_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void GET_PACKET_CONFIG_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void OVERRIDE_PACKET_SEND_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void OVERRIDE_PACKET_RATES_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CLEAR_PACKET_OVERRIDE_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

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

      void log_WARNING_LO_NoChan(
          FwChanIdType Id 
      ) const;

      void log_ACTIVITY_HI_LevelSet(
          FwChanIdType level 
      ) const;

      void log_WARNING_LO_MaxLevelExceed(
          FwChanIdType level, 
          FwChanIdType max 
      ) const;

      void log_ACTIVITY_HI_PacketSent(
          U32 packetId 
      ) const;

      void log_WARNING_LO_PacketNotFound(
          U32 packetId 
      ) const;

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

      void log_WARNING_HI_OversizedChannel(
          FwChanIdType Id, 
          FwSizeType valSize, 
          FwSizeType expected 
      );

      void log_WARNING_LO_ReloadRecordUnknownPacket(
          U32 packetId 
      ) const;

      void log_WARNING_HI_ConfigMirrorAllocFailed();

      void log_ACTIVITY_HI_PacketConfigReport(
          const Svc::TelemetrySection& section, 
          U32 packetId, 
          const Svc::PacketOverrideConfig& override, 
          const Svc::TlmSendConfig& effective 
      ) const;

      void log_ACTIVITY_HI_PacketOverrideSet(
          const Svc::TelemetrySection& section, 
          U32 packetId, 
          const Svc::PacketOverrideConfig& override 
      ) const;

      void log_ACTIVITY_HI_PacketOverrideCleared(
          const Svc::TelemetrySection& section, 
          U32 packetId 
      ) const;

      void log_WARNING_HI_ConfigReloadFailed(
          const Fw::DeserialStatus& status 
      ) const;

      void log_WARNING_LO_InvalidPacketConfig(
          U32 packetId 
      ) const;

      void log_WARNING_LO_ReloadRecordInvalid(
          U32 packetId 
      ) const;

      void log_ACTIVITY_HI_GroupSendStateSet(
          const Svc::TelemetrySection& section, 
          FwChanIdType tlmGroup, 
          const Svc::TlmSendState& sendState 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Event throttle reset functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_OversizedChannel_ThrottleClear();

      void log_WARNING_HI_ConfigMirrorAllocFailed_ThrottleClear();

    protected:

      // ----------------------------------------------------------------------
      // Telemetry serialized write
      // ----------------------------------------------------------------------

      void tlmWrite(
          FwChanIdType id, 
          Fw::TlmBuffer& _tlmBuff, 
          Fw::Time _tlmTime = Fw::Time() 
      ) 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:

      // ----------------------------------------------------------------------
      // Parameter hook functions
      // ----------------------------------------------------------------------

      virtual void parameterUpdated(
          FwPrmIdType id 
      );

      virtual void parametersLoaded();

      virtual void parameterLoaded(
          FwPrmIdType id, 
          Fw::ParamValid valid 
      );

    protected:

      // ----------------------------------------------------------------------
      // Parameter get functions
      // ----------------------------------------------------------------------

      Svc::TlmPacketizer_SectionEnabled paramGet_SECTION_ENABLED(
          Fw::ParamValid& valid 
      );

      Svc::TlmPacketizer_SectionConfigs paramGet_SECTION_CONFIGS(
          Fw::ParamValid& valid 
      );

    protected:

      // ----------------------------------------------------------------------
      // External parameter delegate initialization
      // ----------------------------------------------------------------------

      void registerExternalParameters(
          Fw::ParamExternalDelegate* paramExternalDelegatePtr 
      );

    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_configureSectionGroupRate_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::TelemetrySection& section, 
          FwChanIdType tlmGroup, 
          const Svc::RateLogic& rateLogic, 
          U32 minDelta, 
          U32 maxDelta 
      );

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

      static void m_p_packetOverrideIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      static void m_p_packetOverrideReturnIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

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

    private:

      // ----------------------------------------------------------------------
      // Invocation functions for special output ports
      // ----------------------------------------------------------------------

      void cmdRegOut_out(
          FwIndexType portNum, 
          FwOpcodeType opCode 
      ) const;

      void cmdResponseOut_out(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) const;

      void eventOut_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      ) const;

      Fw::ParamValid paramGetOut_out(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) const;

      void paramSetOut_out(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) const;

#if FW_ENABLE_TEXT_LOGGING

      void textEventOut_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::TextLogString& text 
      ) const;

#endif

      void timeGetOut_out(
          FwIndexType portNum, 
          Fw::Time& time 
      ) const;

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

    private:

      // ----------------------------------------------------------------------
      // Parameter set functions
      // ----------------------------------------------------------------------

      Fw::CmdResponse paramSet_SECTION_ENABLED(
          Fw::SerialBufferBase& val 
      );

      Fw::CmdResponse paramSet_SECTION_CONFIGS(
          Fw::SerialBufferBase& val 
      );

    private:

      // ----------------------------------------------------------------------
      // Parameter save functions
      // ----------------------------------------------------------------------

      Fw::CmdResponse paramSave_SECTION_ENABLED();

      Fw::CmdResponse paramSave_SECTION_CONFIGS();

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    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::InputConfigureGroupRatePort m_configureSectionGroupRate_InputPort[NUM_CONFIGURESECTIONGROUPRATE_INPUT_PORTS];

      Svc::InputEnableSectionPort m_controlIn_InputPort[NUM_CONTROLIN_INPUT_PORTS];

      Fw::InputBufferSendPort m_packetOverrideIn_InputPort[NUM_PACKETOVERRIDEIN_INPUT_PORTS];

      Fw::InputBufferSendPort m_packetOverrideReturnIn_InputPort[NUM_PACKETOVERRIDERETURNIN_INPUT_PORTS];

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

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

      Fw::OutputPrmGetPort m_paramGetOut_OutputPort[NUM_PARAMGETOUT_OUTPUT_PORTS];

      Fw::OutputPrmSetPort m_paramSetOut_OutputPort[NUM_PARAMSETOUT_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];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::OutputComPort m_PktSend_OutputPort[NUM_PKTSEND_OUTPUT_PORTS];

      Fw::OutputBufferGetPort m_allocate_OutputPort[NUM_ALLOCATE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_deallocate_OutputPort[NUM_DEALLOCATE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_packetOverrideOut_OutputPort[NUM_PACKETOVERRIDEOUT_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_packetOverrideReturnOut_OutputPort[NUM_PACKETOVERRIDERETURNOUT_OUTPUT_PORTS];

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

#endif

    private:

      // ----------------------------------------------------------------------
      // Counter values for event throttling
      // ----------------------------------------------------------------------

      std::atomic<FwIndexType> m_OversizedChannelThrottle;

      std::atomic<FwIndexType> m_ConfigMirrorAllocFailedThrottle;

    private:

      // ----------------------------------------------------------------------
      // Parameter validity flags
      // ----------------------------------------------------------------------

      Fw::ParamValid m_param_SECTION_ENABLED_valid = Fw::ParamValid::UNINIT;

      Fw::ParamValid m_param_SECTION_CONFIGS_valid = Fw::ParamValid::UNINIT;

    private:

      // ----------------------------------------------------------------------
      // Parameter delegate
      // ----------------------------------------------------------------------

      Fw::ParamExternalDelegate* paramDelegatePtr = nullptr;

    private:

      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------

      Os::Mutex m_paramLock;

  };

}

#endif