PrmSetPortAc.hpp

Go to the documentation of this file.

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

#ifndef Fw_PrmSetPortAc_HPP
#define Fw_PrmSetPortAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Prm/ParamBuffer.hpp"
#include "Fw/Types/Serializable.hpp"
#include "default/config/FwPrmIdTypeAliasAc.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 PrmSetPortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for PrmSetPortBuffer
      // ----------------------------------------------------------------------

      static constexpr FwSizeType CAPACITY =
        sizeof(FwPrmIdType) +
        Fw::ParamBuffer::SERIALIZED_SIZE;

    public:

      // ----------------------------------------------------------------------
      // Public member functions for PrmSetPortBuffer
      // ----------------------------------------------------------------------

      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 PrmSetPortSerializer {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for PrmSetPortSerializer
      // ----------------------------------------------------------------------

      PrmSetPortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for PrmSetPortSerializer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public static functions for PrmSetPortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          FwPrmIdType id, 
          Fw::ParamBuffer& val, 
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables for PrmSetPortSerializer
      // ----------------------------------------------------------------------

      FwPrmIdType m_id;
      Fw::ParamBuffer m_val;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputPrmSetPort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputPrmSetPort
      // ----------------------------------------------------------------------

      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        FwPrmIdType id,
        Fw::ParamBuffer& val
      );

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputPrmSetPort
      // ----------------------------------------------------------------------

      InputPrmSetPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputPrmSetPort
      // ----------------------------------------------------------------------

      void init();

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

      void invoke(
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputPrmSetPort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

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

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputPrmSetPort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputPrmSetPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputPrmSetPort
      // ----------------------------------------------------------------------

      OutputPrmSetPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputPrmSetPort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputPrmSetPort* callPort 
      );

      void invoke(
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputPrmSetPort
      // ----------------------------------------------------------------------

      InputPrmSetPort* m_port;

  };

#endif

}

#endif