GenericHubComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_GenericHubComponentAc_HPP
#define Svc_GenericHubComponentAc_HPP

#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"

static_assert(
  FW_PORT_SERIALIZATION == 1,
  "GenericHub component requires serialization"
);

namespace Svc {

  class GenericHubComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class GenericHubTesterBase;
      friend class GenericHubTester;

    PROTECTED:

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

      enum {
        NUM_LOGRECV_INPUT_PORTS = 1,
        NUM_TLMRECV_INPUT_PORTS = 1,
        NUM_BUFFERSIN_INPUT_PORTS = 10,
        NUM_DATAIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_PORTIN_INPUT_PORTS = 10,
      };

      enum {
        NUM_LOGSEND_OUTPUT_PORTS = 1,
        NUM_TLMSEND_OUTPUT_PORTS = 1,
        NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1,
        NUM_BUFFERSOUT_OUTPUT_PORTS = 10,
        NUM_DATAINDEALLOCATE_OUTPUT_PORTS = 1,
        NUM_DATAOUT_OUTPUT_PORTS = 1,
        NUM_DATAOUTALLOCATE_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_PORTOUT_OUTPUT_PORTS = 10,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Fw::InputLogPort* get_LogRecv_InputPort(
          FwIndexType portNum 
      );

      Fw::InputTlmPort* get_TlmRecv_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_buffersIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_dataIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for serial input ports
      // ----------------------------------------------------------------------

      Fw::InputSerializePort* get_portIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

      void set_LogSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

      void set_TlmSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

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

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

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

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

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

#if FW_PORT_SERIALIZATION

    public:

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

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

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

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

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

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

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

#endif

#if FW_PORT_SERIALIZATION

    public:

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

      void set_portOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputPortBase* port 
      );

#endif

    PROTECTED:

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

      GenericHubComponentBase(
          const char* compName = "" 
      );

      virtual ~GenericHubComponentBase();

    PROTECTED:

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

      FwIndexType getNum_LogRecv_InputPorts() const;

      FwIndexType getNum_TlmRecv_InputPorts() const;

      FwIndexType getNum_buffersIn_InputPorts() const;

      FwIndexType getNum_dataIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_portIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_LogSend_OutputPorts() const;

      FwIndexType getNum_TlmSend_OutputPorts() const;

      FwIndexType getNum_bufferDeallocate_OutputPorts() const;

      FwIndexType getNum_buffersOut_OutputPorts() const;

      FwIndexType getNum_dataInDeallocate_OutputPorts() const;

      FwIndexType getNum_dataOut_OutputPorts() const;

      FwIndexType getNum_dataOutAllocate_OutputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_portOut_OutputPorts() const;

    PROTECTED:

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

      bool isConnected_LogSend_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_TlmSend_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_bufferDeallocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_buffersOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataInDeallocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataOutAllocate_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      bool isConnected_portOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual void LogRecv_handler(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      ) = 0;

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

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

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

    PROTECTED:

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

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

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

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

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

    PROTECTED:

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

      virtual void portIn_handler(
          FwIndexType portNum, 
          Fw::SerializeBufferBase& buffer 
      ) = 0;

    PROTECTED:

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

      void portIn_handlerBase(
          FwIndexType portNum, 
          Fw::SerializeBufferBase& buffer 
      );

    PROTECTED:

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

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

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

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

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

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

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

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

    PROTECTED:

      // ----------------------------------------------------------------------
      // Invocation functions for serial output ports
      // ----------------------------------------------------------------------

      Fw::SerializeStatus portOut_out(
          FwIndexType portNum, 
          Fw::SerializeBufferBase& buffer 
      );

    PRIVATE:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static void m_p_LogRecv_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      );

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

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

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

    PRIVATE:

      // ----------------------------------------------------------------------
      // Calls for messages received on serial input ports
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION

      static void m_p_portIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::SerializeBufferBase& buffer 
      );

#endif

    PRIVATE:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Fw::InputLogPort m_LogRecv_InputPort[NUM_LOGRECV_INPUT_PORTS];

      Fw::InputTlmPort m_TlmRecv_InputPort[NUM_TLMRECV_INPUT_PORTS];

      Fw::InputBufferSendPort m_buffersIn_InputPort[NUM_BUFFERSIN_INPUT_PORTS];

      Fw::InputBufferSendPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

    PRIVATE:

      // ----------------------------------------------------------------------
      // Serial input ports
      // ----------------------------------------------------------------------

      Fw::InputSerializePort m_portIn_InputPort[NUM_PORTIN_INPUT_PORTS];

    PRIVATE:

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

      Fw::OutputLogPort m_LogSend_OutputPort[NUM_LOGSEND_OUTPUT_PORTS];

      Fw::OutputTlmPort m_TlmSend_OutputPort[NUM_TLMSEND_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_bufferDeallocate_OutputPort[NUM_BUFFERDEALLOCATE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_buffersOut_OutputPort[NUM_BUFFERSOUT_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_dataInDeallocate_OutputPort[NUM_DATAINDEALLOCATE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_dataOut_OutputPort[NUM_DATAOUT_OUTPUT_PORTS];

      Fw::OutputBufferGetPort m_dataOutAllocate_OutputPort[NUM_DATAOUTALLOCATE_OUTPUT_PORTS];

    PRIVATE:

      // ----------------------------------------------------------------------
      // Serial output ports
      // ----------------------------------------------------------------------

      Fw::OutputSerializePort m_portOut_OutputPort[NUM_PORTOUT_OUTPUT_PORTS];

  };

}

#endif