CmdPortAc.hpp

Go to the documentation of this file.

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

#ifndef Fw_CmdPortAc_HPP
#define Fw_CmdPortAc_HPP

#include "Fw/Cmd/CmdArgBuffer.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 CmdPortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for CmdPortBuffer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public member functions for CmdPortBuffer
      // ----------------------------------------------------------------------

      Fw::Serializable::SizeType getCapacity() const override {
        return CAPACITY;
      }

      U8* getBuffAddr() override {
        return m_buff;
      }

      const U8* getBuffAddr() const override {
        return m_buff;
      }

    private:

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

      U8 m_buff[CAPACITY];

  };

  class CmdPortSerializer {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for CmdPortSerializer
      // ----------------------------------------------------------------------

      CmdPortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for CmdPortSerializer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public static functions for CmdPortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args, 
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables for CmdPortSerializer
      // ----------------------------------------------------------------------

      FwOpcodeType m_opCode;
      U32 m_cmdSeq;
      Fw::CmdArgBuffer m_args;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputCmdPort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputCmdPort
      // ----------------------------------------------------------------------

      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        FwOpcodeType opCode,
        U32 cmdSeq,
        Fw::CmdArgBuffer& args
      );

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputCmdPort
      // ----------------------------------------------------------------------

      InputCmdPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputCmdPort
      // ----------------------------------------------------------------------

      void init();

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

      void invoke(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputCmdPort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

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

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputCmdPort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputCmdPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputCmdPort
      // ----------------------------------------------------------------------

      OutputCmdPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputCmdPort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputCmdPort* callPort 
      );

      void invoke(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputCmdPort
      // ----------------------------------------------------------------------

      InputCmdPort* m_port;

  };

#endif

}

#endif