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/ByteStreamDataPortAc.hpp"
#include "Drv/ByteStreamDriverModel/ByteStreamReadyPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Ports/SuccessCondition/SuccessConditionPortAc.hpp"
#include "Svc/Ports/CommsPorts/ComDataWithContextPortAc.hpp"

namespace Svc {

  class ComStubComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class ComStubTesterBase;
      friend class ComStubTester;

    PROTECTED:

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

      enum {
        NUM_DATAIN_INPUT_PORTS = 1,
        NUM_DATARETURNIN_INPUT_PORTS = 1,
        NUM_DRVCONNECTED_INPUT_PORTS = 1,
        NUM_DRVRECEIVEIN_INPUT_PORTS = 1,
        NUM_DRVSENDRETURNIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_COMSTATUSOUT_OUTPUT_PORTS = 1,
        NUM_DATAOUT_OUTPUT_PORTS = 1,
        NUM_DATARETURNOUT_OUTPUT_PORTS = 1,
        NUM_DRVRECEIVERETURNOUT_OUTPUT_PORTS = 1,
        NUM_DRVSENDOUT_OUTPUT_PORTS = 1,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Svc::InputComDataWithContextPort* get_dataIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputComDataWithContextPort* get_dataReturnIn_InputPort(
          FwIndexType portNum 
      );

      Drv::InputByteStreamReadyPort* get_drvConnected_InputPort(
          FwIndexType portNum 
      );

      Drv::InputByteStreamDataPort* get_drvReceiveIn_InputPort(
          FwIndexType portNum 
      );

      Drv::InputByteStreamDataPort* get_drvSendReturnIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

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

      void set_dataOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputComDataWithContextPort* port 
      );

      void set_dataReturnOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputComDataWithContextPort* port 
      );

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

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

#if FW_PORT_SERIALIZATION

    public:

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

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

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

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

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

      void set_drvSendOut_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_dataIn_InputPorts() const;

      FwIndexType getNum_dataReturnIn_InputPorts() const;

      FwIndexType getNum_drvConnected_InputPorts() const;

      FwIndexType getNum_drvReceiveIn_InputPorts() const;

      FwIndexType getNum_drvSendReturnIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_comStatusOut_OutputPorts() const;

      FwIndexType getNum_dataOut_OutputPorts() const;

      FwIndexType getNum_dataReturnOut_OutputPorts() const;

      FwIndexType getNum_drvReceiveReturnOut_OutputPorts() const;

      FwIndexType getNum_drvSendOut_OutputPorts() const;

    PROTECTED:

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

      bool isConnected_comStatusOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataReturnOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_drvReceiveReturnOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_drvSendOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual void dataIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      ) = 0;

      virtual void dataReturnIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      ) = 0;

      virtual void drvConnected_handler(
          FwIndexType portNum 
      ) = 0;

      virtual void drvReceiveIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      ) = 0;

      virtual void drvSendReturnIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      ) = 0;

    PROTECTED:

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

      void dataIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      void dataReturnIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      void drvConnected_handlerBase(
          FwIndexType portNum 
      );

      void drvReceiveIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      );

      void drvSendReturnIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      );

    PROTECTED:

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

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

      void dataOut_out(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      void dataReturnOut_out(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

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

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

    PRIVATE:

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

      static void m_p_dataIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      static void m_p_dataReturnIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

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

      static void m_p_drvReceiveIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      );

      static void m_p_drvSendReturnIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      );

    PRIVATE:

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

      Svc::InputComDataWithContextPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

      Svc::InputComDataWithContextPort m_dataReturnIn_InputPort[NUM_DATARETURNIN_INPUT_PORTS];

      Drv::InputByteStreamReadyPort m_drvConnected_InputPort[NUM_DRVCONNECTED_INPUT_PORTS];

      Drv::InputByteStreamDataPort m_drvReceiveIn_InputPort[NUM_DRVRECEIVEIN_INPUT_PORTS];

      Drv::InputByteStreamDataPort m_drvSendReturnIn_InputPort[NUM_DRVSENDRETURNIN_INPUT_PORTS];

    PRIVATE:

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

      Fw::OutputSuccessConditionPort m_comStatusOut_OutputPort[NUM_COMSTATUSOUT_OUTPUT_PORTS];

      Svc::OutputComDataWithContextPort m_dataOut_OutputPort[NUM_DATAOUT_OUTPUT_PORTS];

      Svc::OutputComDataWithContextPort m_dataReturnOut_OutputPort[NUM_DATARETURNOUT_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_drvReceiveReturnOut_OutputPort[NUM_DRVRECEIVERETURNOUT_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_drvSendOut_OutputPort[NUM_DRVSENDOUT_OUTPUT_PORTS];

  };

}

#endif