CmdResponsePortAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  CmdResponsePortAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for CmdResponse port
// ======================================================================

#ifndef Fw_CmdResponsePortAc_HPP
#define Fw_CmdResponsePortAc_HPP

#include "Fw/Cmd/CmdResponseEnumAc.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/Serializable.hpp"
#include "default/config/FwOpcodeTypeAliasAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Comp/PassiveComponentBase.hpp"
#include "Fw/Port/InputPortBase.hpp"
#include "Fw/Port/OutputPortBase.hpp"
#endif

namespace Fw {

  class CmdResponsePortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for CmdResponsePortBuffer
      // ----------------------------------------------------------------------

      static constexpr FwSizeType CAPACITY =
        sizeof(FwOpcodeType) +
        sizeof(U32) +
        Fw::CmdResponse::SERIALIZED_SIZE;

    public:

      // ----------------------------------------------------------------------
      // Public member functions for CmdResponsePortBuffer
      // ----------------------------------------------------------------------

      CmdResponsePortBuffer() : Fw::LinearBufferBase(m_buff, CAPACITY) {

      }

    private:

      // ----------------------------------------------------------------------
      // Private member variables
      // ----------------------------------------------------------------------

      U8 m_buff[CAPACITY];

  };

  class CmdResponsePortSerializer {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for CmdResponsePortSerializer
      // ----------------------------------------------------------------------

      CmdResponsePortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for CmdResponsePortSerializer
      // ----------------------------------------------------------------------

      Fw::SerializeStatus deserializePortArgs(
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public static functions for CmdResponsePortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response, 
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables for CmdResponsePortSerializer
      // ----------------------------------------------------------------------

      FwOpcodeType m_opCode;
      U32 m_cmdSeq;
      Fw::CmdResponse m_response;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputCmdResponsePort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputCmdResponsePort
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputCmdResponsePort
      // ----------------------------------------------------------------------

      InputCmdResponsePort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputCmdResponsePort
      // ----------------------------------------------------------------------

      void init();

      void addCallComp(
          Fw::PassiveComponentBase* callComp, 
          CompFuncPtr funcPtr 
      );

      void invoke(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputCmdResponsePort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

      Fw::SerializeStatus invokeSerial(
          Fw::LinearBufferBase& _buffer 
      );

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputCmdResponsePort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputCmdResponsePort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputCmdResponsePort
      // ----------------------------------------------------------------------

      OutputCmdResponsePort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputCmdResponsePort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputCmdResponsePort* callPort 
      );

      void invoke(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputCmdResponsePort
      // ----------------------------------------------------------------------

      InputCmdResponsePort* m_port;

  };

#endif

}

#endif