DpManagerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_DpManagerComponentAc_HPP
#define Svc_DpManagerComponentAc_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/Comp/ActiveComponentBase.hpp"
#include "Fw/Dp/DpGetPortAc.hpp"
#include "Fw/Dp/DpRequestPortAc.hpp"
#include "Fw/Dp/DpResponsePortAc.hpp"
#include "Fw/Dp/DpSendPortAc.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/Sched/SchedPortAc.hpp"

namespace Svc {

  class DpManagerComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class DpManagerComponentBaseFriend;
      friend class DpManagerTesterBase;

    PROTECTED:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_PRODUCTGETIN_INPUT_PORTS = 5,
        NUM_PRODUCTREQUESTIN_INPUT_PORTS = 5,
        NUM_PRODUCTSENDIN_INPUT_PORTS = 5,
        NUM_SCHEDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREGIN_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_BUFFERGETOUT_OUTPUT_PORTS = 5,
        NUM_PRODUCTRESPONSEOUT_OUTPUT_PORTS = 5,
        NUM_PRODUCTSENDOUT_OUTPUT_PORTS = 5,
      };

      enum {
        OPCODE_CLEAR_EVENT_THROTTLE = 0x0, 
      };

      enum {
        EVENTID_BUFFERALLOCATIONFAILED = 0x0, 
      };

      enum {
        EVENTID_BUFFERALLOCATIONFAILED_THROTTLE = 10, 
      };

      enum {
        CHANNELID_NUMSUCCESSFULALLOCATIONS = 0x0, 
        CHANNELID_NUMFAILEDALLOCATIONS = 0x1, 
        CHANNELID_NUMDATAPRODUCTS = 0x2, 
        CHANNELID_NUMBYTES = 0x3, 
      };

    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::InputDpGetPort* get_productGetIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputDpRequestPort* get_productRequestIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputDpSendPort* get_productSendIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_schedIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

      void set_cmdRegIn_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_bufferGetOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferGetPort* port 
      );

      void set_productResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputDpResponsePort* port 
      );

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

#if FW_PORT_SERIALIZATION

    public:

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

      void set_cmdRegIn_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_productResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

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

#endif

    public:

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

      void regCommands();

    PROTECTED:

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

      DpManagerComponentBase(
          const char* compName = "" 
      );

      virtual ~DpManagerComponentBase();

    PROTECTED:

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

      FwIndexType getNum_cmdIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_productGetIn_InputPorts() const;

      FwIndexType getNum_productRequestIn_InputPorts() const;

      FwIndexType getNum_productSendIn_InputPorts() const;

      FwIndexType getNum_schedIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_cmdRegIn_OutputPorts() const;

      FwIndexType getNum_cmdResponseOut_OutputPorts() const;

      FwIndexType getNum_eventOut_OutputPorts() const;

#if FW_ENABLE_TEXT_LOGGING == 1

      FwIndexType getNum_textEventOut_OutputPorts() const;

#endif

      FwIndexType getNum_timeGetOut_OutputPorts() const;

      FwIndexType getNum_tlmOut_OutputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_bufferGetOut_OutputPorts() const;

      FwIndexType getNum_productResponseOut_OutputPorts() const;

      FwIndexType getNum_productSendOut_OutputPorts() const;

    PROTECTED:

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

      bool isConnected_cmdRegIn_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_bufferGetOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_productResponseOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_productSendOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual Fw::Success productGetIn_handler(
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize, 
          Fw::Buffer& buffer 
      ) = 0;

      virtual void productRequestIn_handler(
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize 
      ) = 0;

      virtual void productSendIn_handler(
          FwIndexType portNum, 
          FwDpIdType id, 
          const Fw::Buffer& buffer 
      ) = 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
      // ----------------------------------------------------------------------

      Fw::Success productGetIn_handlerBase(
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize, 
          Fw::Buffer& buffer 
      );

      void productRequestIn_handlerBase(
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize 
      );

      void productSendIn_handlerBase(
          FwIndexType portNum, 
          FwDpIdType id, 
          const Fw::Buffer& buffer 
      );

      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 productRequestIn_preMsgHook(
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize 
      );

      virtual void productSendIn_preMsgHook(
          FwIndexType portNum, 
          FwDpIdType id, 
          const Fw::Buffer& buffer 
      );

      virtual void schedIn_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );

    PROTECTED:

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

      Fw::Buffer bufferGetOut_out(
          FwIndexType portNum, 
          U32 size 
      );

      void productResponseOut_out(
          FwIndexType portNum, 
          FwDpIdType id, 
          const Fw::Buffer& buffer, 
          const Fw::Success& status 
      );

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

    PROTECTED:

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

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

    PROTECTED:

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

      virtual void CLEAR_EVENT_THROTTLE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

    PROTECTED:

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

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

    PROTECTED:

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

      void log_WARNING_HI_BufferAllocationFailed(
          U32 id 
      );

    PROTECTED:

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

      void log_WARNING_HI_BufferAllocationFailed_ThrottleClear();

    PROTECTED:

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

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

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

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

      void tlmWrite_NumBytes(
          U64 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

    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 Fw::Success m_p_productGetIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize, 
          Fw::Buffer& buffer 
      );

      static void m_p_productRequestIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize 
      );

      static void m_p_productSendIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwDpIdType id, 
          const Fw::Buffer& buffer 
      );

      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::InputDpGetPort m_productGetIn_InputPort[NUM_PRODUCTGETIN_INPUT_PORTS];

      Fw::InputDpRequestPort m_productRequestIn_InputPort[NUM_PRODUCTREQUESTIN_INPUT_PORTS];

      Fw::InputDpSendPort m_productSendIn_InputPort[NUM_PRODUCTSENDIN_INPUT_PORTS];

      Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];

    PRIVATE:

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

      Fw::OutputCmdRegPort m_cmdRegIn_OutputPort[NUM_CMDREGIN_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::OutputBufferGetPort m_bufferGetOut_OutputPort[NUM_BUFFERGETOUT_OUTPUT_PORTS];

      Fw::OutputDpResponsePort m_productResponseOut_OutputPort[NUM_PRODUCTRESPONSEOUT_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_productSendOut_OutputPort[NUM_PRODUCTSENDOUT_OUTPUT_PORTS];

    PRIVATE:

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

      std::atomic<FwIndexType> m_BufferAllocationFailedThrottle;

    PRIVATE:

      // ----------------------------------------------------------------------
      // First update flags for telemetry channels
      // ----------------------------------------------------------------------

      bool m_first_update_NumSuccessfulAllocations;

      bool m_first_update_NumFailedAllocations;

      bool m_first_update_NumDataProducts;

      bool m_first_update_NumBytes;

    PRIVATE:

      // ----------------------------------------------------------------------
      // Last value storage for telemetry channels
      // ----------------------------------------------------------------------

      U32 m_last_NumSuccessfulAllocations;

      U32 m_last_NumFailedAllocations;

      U32 m_last_NumDataProducts;

      U64 m_last_NumBytes;

  };

}

#endif