FrameAccumulatorComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FrameAccumulatorComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for FrameAccumulator component base class
// ======================================================================

#ifndef Svc_FrameAccumulatorComponentAc_HPP
#define Svc_FrameAccumulatorComponentAc_HPP

#include <atomic>

#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ports/CommsPorts/ComDataWithContextPortAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"

namespace Svc {

  class FrameAccumulatorComponentBase :
    public Fw::PassiveComponentBase
  {

      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------

      friend class FrameAccumulatorTesterBase;
      friend class FrameAccumulatorTester;

    protected:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        NUM_DATAIN_INPUT_PORTS = 1,
        NUM_DATARETURNIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_LOGOUT_OUTPUT_PORTS = 1,
        NUM_LOGTEXTOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_BUFFERALLOCATE_OUTPUT_PORTS = 1,
        NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1,
        NUM_DATAOUT_OUTPUT_PORTS = 1,
        NUM_DATARETURNOUT_OUTPUT_PORTS = 1,
      };

      enum {
        EVENTID_NOBUFFERAVAILABLE = 0x0, 
        EVENTID_FRAMEDETECTIONSIZEERROR = 0x1, 
      };

    public:

      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Svc::InputComDataWithContextPort* get_dataIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputComDataWithContextPort* get_dataReturnIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------

      void set_logOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_logTextOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_bufferAllocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferGetPort* port 
      );

      void set_bufferDeallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_dataOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputComDataWithContextPort* port 
      );

      void set_dataReturnOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputComDataWithContextPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------

      void set_logOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_logTextOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_bufferDeallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_dataOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_dataReturnOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    protected:

      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------

      FrameAccumulatorComponentBase(
          const char* compName = "" 
      );

      virtual ~FrameAccumulatorComponentBase();

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_dataIn_InputPorts() {
        return NUM_DATAIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataReturnIn_InputPorts() {
        return NUM_DATARETURNIN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_logOut_OutputPorts() {
        return NUM_LOGOUT_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_logTextOut_OutputPorts() {
        return NUM_LOGTEXTOUT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_bufferAllocate_OutputPorts() {
        return NUM_BUFFERALLOCATE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_bufferDeallocate_OutputPorts() {
        return NUM_BUFFERDEALLOCATE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataOut_OutputPorts() {
        return NUM_DATAOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataReturnOut_OutputPorts() {
        return NUM_DATARETURNOUT_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------

      bool isConnected_logOut_OutputPort(
          FwIndexType portNum 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_logTextOut_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------

      bool isConnected_bufferAllocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_bufferDeallocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dataReturnOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual void dataIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      ) = 0;

      virtual void dataReturnIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      void dataIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      void dataReturnIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

    protected:

      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------

      Fw::Buffer bufferAllocate_out(
          FwIndexType portNum, 
          FwSizeType size 
      );

      void bufferDeallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void dataOut_out(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      void dataReturnOut_out(
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

    protected:

      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_NoBufferAvailable() const;

      void log_WARNING_HI_FrameDetectionSizeError(FwSizeType size_out) const;

    protected:

      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------

      Fw::Time getTime() const;

    protected:

      // ----------------------------------------------------------------------
      // Mutex operations for guarded ports
      //
      // You can override these operations to provide more sophisticated
      // synchronization
      // ----------------------------------------------------------------------

      virtual void lock();

      virtual void unLock();

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static void m_p_dataIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      static void m_p_dataReturnIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

    private:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Svc::InputComDataWithContextPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

      Svc::InputComDataWithContextPort m_dataReturnIn_InputPort[NUM_DATARETURNIN_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

      Fw::OutputLogPort m_logOut_OutputPort[NUM_LOGOUT_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_logTextOut_OutputPort[NUM_LOGTEXTOUT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------

      Fw::OutputBufferGetPort m_bufferAllocate_OutputPort[NUM_BUFFERALLOCATE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_bufferDeallocate_OutputPort[NUM_BUFFERDEALLOCATE_OUTPUT_PORTS];

      Svc::OutputComDataWithContextPort m_dataOut_OutputPort[NUM_DATAOUT_OUTPUT_PORTS];

      Svc::OutputComDataWithContextPort m_dataReturnOut_OutputPort[NUM_DATARETURNOUT_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------

      Os::Mutex m_guardedPortMutex;

  };

}

#endif