CmdSplitterComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_CmdSplitterComponentAc_HPP
#define Svc_CmdSplitterComponentAc_HPP

#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Com/ComPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"

namespace Svc {

  class CmdSplitterComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class CmdSplitterTesterBase;
      friend class CmdSplitterTester;

    protected:

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

      enum {
        NUM_CMDBUFF_INPUT_PORTS = 5,
        NUM_SEQCMDSTATUS_INPUT_PORTS = 5,
      };

      enum {
        NUM_LOCALCMD_OUTPUT_PORTS = 5,
        NUM_REMOTECMD_OUTPUT_PORTS = 5,
        NUM_FORWARDSEQCMDSTATUS_OUTPUT_PORTS = 5,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Fw::InputComPort* get_CmdBuff_InputPort(
          FwIndexType portNum 
      );

      Fw::InputCmdResponsePort* get_seqCmdStatus_InputPort(
          FwIndexType portNum 
      );

    public:

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

      void set_LocalCmd_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* port 
      );

      void set_RemoteCmd_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* port 
      );

      void set_forwardSeqCmdStatus_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

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

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

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

#endif

    protected:

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

      CmdSplitterComponentBase(
          const char* compName = "" 
      );

      virtual ~CmdSplitterComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_CmdBuff_InputPorts() {
        return NUM_CMDBUFF_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_seqCmdStatus_InputPorts() {
        return NUM_SEQCMDSTATUS_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_LocalCmd_OutputPorts() {
        return NUM_LOCALCMD_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_RemoteCmd_OutputPorts() {
        return NUM_REMOTECMD_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_forwardSeqCmdStatus_OutputPorts() {
        return NUM_FORWARDSEQCMDSTATUS_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_LocalCmd_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_RemoteCmd_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_forwardSeqCmdStatus_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void CmdBuff_handler(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      ) = 0;

      virtual void seqCmdStatus_handler(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) = 0;

    protected:

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

      void CmdBuff_handlerBase(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      void seqCmdStatus_handlerBase(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );

    protected:

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

      void LocalCmd_out(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      void RemoteCmd_out(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      void forwardSeqCmdStatus_out(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );

    private:

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

      static void m_p_CmdBuff_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      static void m_p_seqCmdStatus_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );

    private:

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

      Fw::InputComPort m_CmdBuff_InputPort[NUM_CMDBUFF_INPUT_PORTS];

      Fw::InputCmdResponsePort m_seqCmdStatus_InputPort[NUM_SEQCMDSTATUS_INPUT_PORTS];

    private:

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

      Fw::OutputComPort m_LocalCmd_OutputPort[NUM_LOCALCMD_OUTPUT_PORTS];

      Fw::OutputComPort m_RemoteCmd_OutputPort[NUM_REMOTECMD_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_forwardSeqCmdStatus_OutputPort[NUM_FORWARDSEQCMDSTATUS_OUTPUT_PORTS];

  };

}

#endif