ReadyPortAc.hpp

Go to the documentation of this file.

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

#ifndef Fw_ReadyPortAc_HPP
#define Fw_ReadyPortAc_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 ReadyPortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for ReadyPortBuffer
      // ----------------------------------------------------------------------

      static constexpr FwSizeType CAPACITY =
        0;

    public:

      // ----------------------------------------------------------------------
      // Public member functions for ReadyPortBuffer
      // ----------------------------------------------------------------------

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

      U8* getBuffAddr() override {
        return nullptr;
      }

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

  };

#if !FW_DIRECT_PORT_CALLS

  class InputReadyPort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputReadyPort
      // ----------------------------------------------------------------------

      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum
      );

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputReadyPort
      // ----------------------------------------------------------------------

      InputReadyPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputReadyPort
      // ----------------------------------------------------------------------

      void init();

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

      void invoke();

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputReadyPort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

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

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputReadyPort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputReadyPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputReadyPort
      // ----------------------------------------------------------------------

      OutputReadyPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputReadyPort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputReadyPort* callPort 
      );

      void invoke() const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputReadyPort
      // ----------------------------------------------------------------------

      InputReadyPort* m_port;

  };

#endif

}

#endif