ComRetryComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_ComRetryComponentAc_HPP
#define Svc_ComRetryComponentAc_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 ComRetryComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class ComRetryTesterBase;
      friend class ComRetryTester;

    protected:

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

      enum {
        NUM_COMSTATUSIN_INPUT_PORTS = 1,
        NUM_DATAIN_INPUT_PORTS = 1,
        NUM_DATARETURNIN_INPUT_PORTS = 1,
      };

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

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Fw::InputSuccessConditionPort* get_comStatusIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputComDataWithContextPort* get_dataIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputComDataWithContextPort* get_dataReturnIn_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 
      );

#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 
      );

#endif

    protected:

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

      ComRetryComponentBase(
          const char* compName = "" 
      );

      virtual ~ComRetryComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_comStatusIn_InputPorts() {
        return NUM_COMSTATUSIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataIn_InputPorts() {
        return NUM_DATAIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataReturnIn_InputPorts() {
        return NUM_DATARETURNIN_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_comStatusOut_OutputPorts() {
        return NUM_COMSTATUSOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataOut_OutputPorts() {
        return NUM_DATAOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataReturnOut_OutputPorts() {
        return NUM_DATARETURNOUT_OUTPUT_PORTS;
      }

    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 
      );

    protected:

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

      virtual void comStatusIn_handler(
          FwIndexType portNum, 
          Fw::Success& condition 
      ) = 0;

      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;

    protected:

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

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

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

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

    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
      );

    private:

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

      static void m_p_comStatusIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Success& condition 
      );

      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
      );

    private:

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

      Fw::InputSuccessConditionPort m_comStatusIn_InputPort[NUM_COMSTATUSIN_INPUT_PORTS];

      Svc::InputComDataWithContextPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

      Svc::InputComDataWithContextPort m_dataReturnIn_InputPort[NUM_DATARETURNIN_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];

  };

}

#endif