ComQueueComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  ComQueueComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for ComQueue component base class
// ======================================================================
 
#ifndef Svc_ComQueueComponentAc_HPP
#define Svc_ComQueueComponentAc_HPP
 
#include "FpConfig.hpp"
#include "Fw/Buffer/BufferSendPortAc.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/Ports/SuccessCondition/SuccessConditionPortAc.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Svc/ComQueue/BuffQueueDepthArrayAc.hpp"
#include "Svc/ComQueue/ComQueueDepthArrayAc.hpp"
#include "Svc/ComQueue/QueueTypeEnumAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
 
namespace Svc {
 
  class ComQueueComponentBase :
    public Fw::ActiveComponentBase
  {
 
      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------
 
      friend class ComQueueComponentBaseFriend;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------
 
      enum {
        NUM_BUFFQUEUEIN_INPUT_PORTS = 1,
        NUM_COMQUEUEIN_INPUT_PORTS = 2,
        NUM_COMSTATUSIN_INPUT_PORTS = 1,
        NUM_RUN_INPUT_PORTS = 1,
      };
 
      enum {
        NUM_LOG_OUTPUT_PORTS = 1,
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_TIME_OUTPUT_PORTS = 1,
        NUM_TLM_OUTPUT_PORTS = 1,
      };
 
      enum {
        NUM_BUFFQUEUESEND_OUTPUT_PORTS = 1,
        NUM_COMQUEUESEND_OUTPUT_PORTS = 1,
        NUM_DEALLOCATE_OUTPUT_PORTS = 1,
      };
 
      enum {
        EVENTID_QUEUEOVERFLOW = 0x0, 
      };
 
      enum {
        CHANNELID_COMQUEUEDEPTH = 0x0, 
        CHANNELID_BUFFQUEUEDEPTH = 0x1, 
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------
 
      void init(
          FwSizeType queueDepth, 
          FwEnumStoreType instance = 0 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputBufferSendPort* get_buffQueueIn_InputPort(
          FwIndexType portNum 
      );
 
      Fw::InputComPort* get_comQueueIn_InputPort(
          FwIndexType portNum 
      );
 
      Fw::InputSuccessConditionPort* get_comStatusIn_InputPort(
          FwIndexType portNum 
      );
 
      Svc::InputSchedPort* get_run_InputPort(
          FwIndexType portNum 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------
 
      void set_Log_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );
 
#endif
 
      void set_Time_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );
 
      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------
 
      void set_buffQueueSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
      void set_comQueueSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* port 
      );
 
      void set_deallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
#if FW_PORT_SERIALIZATION
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------
 
      void set_Log_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
      void set_Time_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
#if FW_PORT_SERIALIZATION
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------
 
      void set_buffQueueSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_comQueueSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_deallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------
 
      ComQueueComponentBase(
          const char* compName = "" 
      );
 
      virtual ~ComQueueComponentBase();
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_buffQueueIn_InputPorts() const;
 
      FwIndexType getNum_comQueueIn_InputPorts() const;
 
      FwIndexType getNum_comStatusIn_InputPorts() const;
 
      FwIndexType getNum_run_InputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_Log_OutputPorts() const;
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      FwIndexType getNum_LogText_OutputPorts() const;
 
#endif
 
      FwIndexType getNum_Time_OutputPorts() const;
 
      FwIndexType getNum_Tlm_OutputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_buffQueueSend_OutputPorts() const;
 
      FwIndexType getNum_comQueueSend_OutputPorts() const;
 
      FwIndexType getNum_deallocate_OutputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------
 
      bool isConnected_Log_OutputPort(
          FwIndexType portNum 
      );
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );
 
#endif
 
      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_Tlm_OutputPort(
          FwIndexType portNum 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------
 
      bool isConnected_buffQueueSend_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_comQueueSend_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_deallocate_OutputPort(
          FwIndexType portNum 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------
 
      virtual void buffQueueIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;
 
      virtual void comQueueIn_handler(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      ) = 0;
 
      virtual void comStatusIn_handler(
          FwIndexType portNum, 
          Fw::Success& condition 
      ) = 0;
 
      virtual void run_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 buffQueueIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      void comQueueIn_handlerBase(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      void comStatusIn_handlerBase(
          FwIndexType portNum, 
          Fw::Success& condition 
      );
 
      void run_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 buffQueueIn_preMsgHook(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      virtual void comQueueIn_preMsgHook(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      virtual void comStatusIn_preMsgHook(
          FwIndexType portNum, 
          Fw::Success& condition 
      );
 
      virtual void run_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Hooks for typed async input ports
      //
      // Each of these functions is invoked when placing a message on the
      // queue would cause the queue to overlow. You should override them to provide
      // specific overflow behavior.
      // ----------------------------------------------------------------------
 
      virtual void buffQueueIn_overflowHook(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------
 
      void buffQueueSend_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      void comQueueSend_out(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      void deallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------
 
      void log_WARNING_HI_QueueOverflow(
          Svc::QueueType queueType, 
          U32 index 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------
 
      void tlmWrite_comQueueDepth(
          const Svc::ComQueueDepth& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );
 
      void tlmWrite_buffQueueDepth(
          const Svc::BuffQueueDepth& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------
 
      Fw::Time getTime();
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Message dispatch functions
      // ----------------------------------------------------------------------
 
      virtual MsgDispatchStatus doDispatch();
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------
 
      static void m_p_buffQueueIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      static void m_p_comQueueIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      static void m_p_comStatusIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Success& condition 
      );
 
      static void m_p_run_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputBufferSendPort m_buffQueueIn_InputPort[NUM_BUFFQUEUEIN_INPUT_PORTS];
 
      Fw::InputComPort m_comQueueIn_InputPort[NUM_COMQUEUEIN_INPUT_PORTS];
 
      Fw::InputSuccessConditionPort m_comStatusIn_InputPort[NUM_COMSTATUSIN_INPUT_PORTS];
 
      Svc::InputSchedPort m_run_InputPort[NUM_RUN_INPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------
 
      Fw::OutputLogPort m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS];
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];
 
#endif
 
      Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];
 
      Fw::OutputTlmPort m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------
 
      Fw::OutputBufferSendPort m_buffQueueSend_OutputPort[NUM_BUFFQUEUESEND_OUTPUT_PORTS];
 
      Fw::OutputComPort m_comQueueSend_OutputPort[NUM_COMQUEUESEND_OUTPUT_PORTS];
 
      Fw::OutputBufferSendPort m_deallocate_OutputPort[NUM_DEALLOCATE_OUTPUT_PORTS];
 
  };
 
}
 
#endif