ComStubComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_ComStubComponentAc_HPP
#define Svc_ComStubComponentAc_HPP

#include "Drv/ByteStreamDriverModel/ByteStreamReadyPortAc.hpp"
#include "Drv/ByteStreamDriverModel/ByteStreamRecvPortAc.hpp"
#include "Drv/ByteStreamDriverModel/ByteStreamSendPortAc.hpp"
#include "FpConfig.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Ports/SuccessCondition/SuccessConditionPortAc.hpp"

namespace Svc {

  class ComStubComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class ComStubComponentBaseFriend;

    PROTECTED:

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

      enum {
        NUM_COMDATAIN_INPUT_PORTS = 1,
        NUM_DRVCONNECTED_INPUT_PORTS = 1,
        NUM_DRVDATAIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_COMDATAOUT_OUTPUT_PORTS = 1,
        NUM_COMSTATUS_OUTPUT_PORTS = 1,
        NUM_DRVDATAOUT_OUTPUT_PORTS = 1,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Drv::InputByteStreamSendPort* get_comDataIn_InputPort(
          FwIndexType portNum 
      );

      Drv::InputByteStreamReadyPort* get_drvConnected_InputPort(
          FwIndexType portNum 
      );

      Drv::InputByteStreamRecvPort* get_drvDataIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

      void set_comDataOut_OutputPort(
          FwIndexType portNum, 
          Drv::InputByteStreamRecvPort* port 
      );

      void set_comStatus_OutputPort(
          FwIndexType portNum, 
          Fw::InputSuccessConditionPort* port 
      );

      void set_drvDataOut_OutputPort(
          FwIndexType portNum, 
          Drv::InputByteStreamSendPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

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

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

#endif

    PROTECTED:

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

      ComStubComponentBase(
          const char* compName = "" 
      );

      virtual ~ComStubComponentBase();

    PROTECTED:

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

      FwIndexType getNum_comDataIn_InputPorts() const;

      FwIndexType getNum_drvConnected_InputPorts() const;

      FwIndexType getNum_drvDataIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_comDataOut_OutputPorts() const;

      FwIndexType getNum_comStatus_OutputPorts() const;

      FwIndexType getNum_drvDataOut_OutputPorts() const;

    PROTECTED:

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

      bool isConnected_comDataOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_comStatus_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_drvDataOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual Drv::SendStatus comDataIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      ) = 0;

      virtual void drvConnected_handler(
          FwIndexType portNum 
      ) = 0;

      virtual void drvDataIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      ) = 0;

    PROTECTED:

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

      Drv::SendStatus comDataIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      );

      void drvConnected_handlerBase(
          FwIndexType portNum 
      );

      void drvDataIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      );

    PROTECTED:

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

      void comDataOut_out(
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      );

      void comStatus_out(
          FwIndexType portNum, 
          Fw::Success& condition 
      );

      Drv::SendStatus drvDataOut_out(
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      );

    PRIVATE:

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

      static Drv::SendStatus m_p_comDataIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      );

      static void m_p_drvConnected_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum 
      );

      static void m_p_drvDataIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& recvBuffer,
          const Drv::RecvStatus& recvStatus
      );

    PRIVATE:

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

      Drv::InputByteStreamSendPort m_comDataIn_InputPort[NUM_COMDATAIN_INPUT_PORTS];

      Drv::InputByteStreamReadyPort m_drvConnected_InputPort[NUM_DRVCONNECTED_INPUT_PORTS];

      Drv::InputByteStreamRecvPort m_drvDataIn_InputPort[NUM_DRVDATAIN_INPUT_PORTS];

    PRIVATE:

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

      Drv::OutputByteStreamRecvPort m_comDataOut_OutputPort[NUM_COMDATAOUT_OUTPUT_PORTS];

      Fw::OutputSuccessConditionPort m_comStatus_OutputPort[NUM_COMSTATUS_OUTPUT_PORTS];

      Drv::OutputByteStreamSendPort m_drvDataOut_OutputPort[NUM_DRVDATAOUT_OUTPUT_PORTS];

  };

}

#endif