ComPortAc.hpp

Go to the documentation of this file.

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

#ifndef Fw_ComPortAc_HPP
#define Fw_ComPortAc_HPP

#include "Fw/Com/ComBuffer.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/Serializable.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 ComPortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for ComPortBuffer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public member functions for ComPortBuffer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public constructors for ComPortSerializer
      // ----------------------------------------------------------------------

      ComPortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for ComPortSerializer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public static functions for ComPortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          Fw::ComBuffer& data, 
          U32 context, 
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables for ComPortSerializer
      // ----------------------------------------------------------------------

      Fw::ComBuffer m_data;
      U32 m_context;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputComPort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputComPort
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputComPort
      // ----------------------------------------------------------------------

      InputComPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputComPort
      // ----------------------------------------------------------------------

      void init();

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

      void invoke(
          Fw::ComBuffer& data, 
          U32 context 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputComPort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

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

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputComPort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputComPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputComPort
      // ----------------------------------------------------------------------

      OutputComPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputComPort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputComPort* callPort 
      );

      void invoke(
          Fw::ComBuffer& data, 
          U32 context 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputComPort
      // ----------------------------------------------------------------------

      InputComPort* m_port;

  };

#endif

}

#endif