DeframerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  DeframerComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for Deframer component base class
// ======================================================================
 
#ifndef Svc_DeframerComponentAc_HPP
#define Svc_DeframerComponentAc_HPP
 
#include "Drv/ByteStreamDriverModel/ByteStreamPollPortAc.hpp"
#include "Drv/ByteStreamDriverModel/ByteStreamRecvPortAc.hpp"
#include "FpConfig.hpp"
#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Com/ComPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
 
namespace Svc {
 
  class DeframerComponentBase :
    public Fw::PassiveComponentBase
  {
 
      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------
 
      friend class DeframerComponentBaseFriend;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------
 
      enum {
        NUM_CMDRESPONSEIN_INPUT_PORTS = 1,
        NUM_FRAMEDIN_INPUT_PORTS = 1,
        NUM_SCHEDIN_INPUT_PORTS = 1,
      };
 
      enum {
        NUM_BUFFERALLOCATE_OUTPUT_PORTS = 1,
        NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1,
        NUM_BUFFEROUT_OUTPUT_PORTS = 1,
        NUM_COMOUT_OUTPUT_PORTS = 1,
        NUM_FRAMEDDEALLOCATE_OUTPUT_PORTS = 1,
        NUM_FRAMEDPOLL_OUTPUT_PORTS = 1,
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------
 
      void init(
          FwEnumStoreType instance = 0 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputCmdResponsePort* get_cmdResponseIn_InputPort(
          FwIndexType portNum 
      );
 
      Drv::InputByteStreamRecvPort* get_framedIn_InputPort(
          FwIndexType portNum 
      );
 
      Svc::InputSchedPort* get_schedIn_InputPort(
          FwIndexType portNum 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------
 
      void set_bufferAllocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferGetPort* port 
      );
 
      void set_bufferDeallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
      void set_bufferOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
      void set_comOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* port 
      );
 
      void set_framedDeallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );
 
      void set_framedPoll_OutputPort(
          FwIndexType portNum, 
          Drv::InputByteStreamPollPort* port 
      );
 
#if FW_PORT_SERIALIZATION
 
    public:
 
      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------
 
      void set_bufferDeallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_bufferOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_comOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
      void set_framedDeallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );
 
#endif
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------
 
      DeframerComponentBase(
          const char* compName = "" 
      );
 
      virtual ~DeframerComponentBase();
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_cmdResponseIn_InputPorts() const;
 
      FwIndexType getNum_framedIn_InputPorts() const;
 
      FwIndexType getNum_schedIn_InputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------
 
      FwIndexType getNum_bufferAllocate_OutputPorts() const;
 
      FwIndexType getNum_bufferDeallocate_OutputPorts() const;
 
      FwIndexType getNum_bufferOut_OutputPorts() const;
 
      FwIndexType getNum_comOut_OutputPorts() const;
 
      FwIndexType getNum_framedDeallocate_OutputPorts() const;
 
      FwIndexType getNum_framedPoll_OutputPorts() const;
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------
 
      bool isConnected_bufferAllocate_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_bufferDeallocate_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_bufferOut_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_comOut_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_framedDeallocate_OutputPort(
          FwIndexType portNum 
      );
 
      bool isConnected_framedPoll_OutputPort(
          FwIndexType portNum 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------
 
      virtual void cmdResponseIn_handler(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) = 0;
 
      virtual void framedIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      ) = 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
      // ----------------------------------------------------------------------
 
      void cmdResponseIn_handlerBase(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );
 
      void framedIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      );
 
      void schedIn_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------
 
      Fw::Buffer bufferAllocate_out(
          FwIndexType portNum, 
          U32 size 
      );
 
      void bufferDeallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      void bufferOut_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      void comOut_out(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );
 
      void framedDeallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );
 
      Drv::PollStatus framedPoll_out(
          FwIndexType portNum, 
          Fw::Buffer& pollBuffer
      );
 
    PROTECTED:
 
      // ----------------------------------------------------------------------
      // Mutex operations for guarded ports
      //
      // You can override these operations to provide more sophisticated
      // synchronization
      // ----------------------------------------------------------------------
 
      virtual void lock();
 
      virtual void unLock();
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------
 
      static void m_p_cmdResponseIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );
 
      static void m_p_framedIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      );
 
      static void m_p_schedIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------
 
      Fw::InputCmdResponsePort m_cmdResponseIn_InputPort[NUM_CMDRESPONSEIN_INPUT_PORTS];
 
      Drv::InputByteStreamRecvPort m_framedIn_InputPort[NUM_FRAMEDIN_INPUT_PORTS];
 
      Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------
 
      Fw::OutputBufferGetPort m_bufferAllocate_OutputPort[NUM_BUFFERALLOCATE_OUTPUT_PORTS];
 
      Fw::OutputBufferSendPort m_bufferDeallocate_OutputPort[NUM_BUFFERDEALLOCATE_OUTPUT_PORTS];
 
      Fw::OutputBufferSendPort m_bufferOut_OutputPort[NUM_BUFFEROUT_OUTPUT_PORTS];
 
      Fw::OutputComPort m_comOut_OutputPort[NUM_COMOUT_OUTPUT_PORTS];
 
      Fw::OutputBufferSendPort m_framedDeallocate_OutputPort[NUM_FRAMEDDEALLOCATE_OUTPUT_PORTS];
 
      Drv::OutputByteStreamPollPort m_framedPoll_OutputPort[NUM_FRAMEDPOLL_OUTPUT_PORTS];
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------
 
      Os::Mutex m_guardedPortMutex;
 
  };
 
}
 
#endif