BufferRepeaterComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferRepeaterComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for BufferRepeater component base class
// ======================================================================
 
#ifndef Svc_BufferRepeaterComponentAc_HPP
#define Svc_BufferRepeaterComponentAc_HPP
 
#include "FpConfig.hpp"
#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.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/Time/TimePortAc.hpp"
 
namespace Svc {
 
  class BufferRepeaterComponentBase :
    public Fw::PassiveComponentBase
  {
 
      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------
 
      friend class BufferRepeaterComponentBaseFriend;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------
 
      enum {
        NUM_PORTIN_INPUT_PORTS = 1,
      };
 
      enum {
        NUM_LOG_OUTPUT_PORTS = 1,
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_TIME_OUTPUT_PORTS = 1,
      };
 
      enum {
        NUM_ALLOCATE_OUTPUT_PORTS = 1,
        NUM_DEALLOCATE_OUTPUT_PORTS = 1,
        NUM_PORTOUT_OUTPUT_PORTS = 10,
      };
 
      enum {
        EVENTID_ALLOCATIONSOFTFAILURE = 0x0, 
        EVENTID_ALLOCATIONHARDFAILURE = 0x1, 
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------
 
      void init(
          FwEnumStoreType instance = 0 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputBufferSendPort* get_portIn_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 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------
 
      void set_allocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferGetPort* port 
      );
 
      void set_deallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
      void set_portOut_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 
      );
 
#endif
 
#if FW_PORT_SERIALIZATION
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------
 
      void set_deallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_portOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------
 
      BufferRepeaterComponentBase(
          const char* compName = "" 
      );
 
      virtual ~BufferRepeaterComponentBase();
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_portIn_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;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_allocate_OutputPorts() const;
 
      FwIndexType getNum_deallocate_OutputPorts() const;
 
      FwIndexType getNum_portOut_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 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------
 
      bool isConnected_allocate_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_deallocate_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_portOut_OutputPort(
          FwIndexType portNum 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------
 
      virtual void portIn_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 portIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------
 
      Fw::Buffer allocate_out(
          FwIndexType portNum, 
          U32 size 
      );
 
      void deallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      void portOut_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------
 
      void log_WARNING_HI_AllocationSoftFailure(
          I32 port, 
          U32 size 
      ) const;
 
      void log_FATAL_AllocationHardFailure(
          I32 port, 
          U32 size 
      ) const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------
 
      Fw::Time getTime();
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------
 
      static void m_p_portIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputBufferSendPort m_portIn_InputPort[NUM_PORTIN_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];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------
 
      Fw::OutputBufferGetPort m_allocate_OutputPort[NUM_ALLOCATE_OUTPUT_PORTS];
 
      Fw::OutputBufferSendPort m_deallocate_OutputPort[NUM_DEALLOCATE_OUTPUT_PORTS];
 
      Fw::OutputBufferSendPort m_portOut_OutputPort[NUM_PORTOUT_OUTPUT_PORTS];
 
  };
 
}
 
#endif