FramerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_FramerComponentAc_HPP
#define Svc_FramerComponentAc_HPP

#include "Drv/ByteStreamDriverModel/ByteStreamSendPortAc.hpp"
#include "FpConfig.hpp"
#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Com/ComPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Ports/SuccessCondition/SuccessConditionPortAc.hpp"
#include "Os/Mutex.hpp"

namespace Svc {

  class FramerComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class FramerComponentBaseFriend;

    PROTECTED:

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

      enum {
        NUM_BUFFERIN_INPUT_PORTS = 1,
        NUM_COMIN_INPUT_PORTS = 1,
        NUM_COMSTATUSIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1,
        NUM_COMSTATUSOUT_OUTPUT_PORTS = 1,
        NUM_FRAMEDALLOCATE_OUTPUT_PORTS = 1,
        NUM_FRAMEDOUT_OUTPUT_PORTS = 1,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Fw::InputBufferSendPort* get_bufferIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputComPort* get_comIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputSuccessConditionPort* get_comStatusIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

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

      void set_comStatusOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSuccessConditionPort* port 
      );

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

      void set_framedOut_OutputPort(
          FwIndexType portNum, 
          Drv::InputByteStreamSendPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

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

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

#endif

    PROTECTED:

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

      FramerComponentBase(
          const char* compName = "" 
      );

      virtual ~FramerComponentBase();

    PROTECTED:

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

      FwIndexType getNum_bufferIn_InputPorts() const;

      FwIndexType getNum_comIn_InputPorts() const;

      FwIndexType getNum_comStatusIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_bufferDeallocate_OutputPorts() const;

      FwIndexType getNum_comStatusOut_OutputPorts() const;

      FwIndexType getNum_framedAllocate_OutputPorts() const;

      FwIndexType getNum_framedOut_OutputPorts() const;

    PROTECTED:

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

      bool isConnected_bufferDeallocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_comStatusOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_framedAllocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_framedOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual void bufferIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

      virtual void comIn_handler(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      ) = 0;

      virtual void comStatusIn_handler(
          FwIndexType portNum, 
          Fw::Success& condition 
      ) = 0;

    PROTECTED:

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

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

      void comIn_handlerBase(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      void comStatusIn_handlerBase(
          FwIndexType portNum, 
          Fw::Success& condition 
      );

    PROTECTED:

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

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

      void comStatusOut_out(
          FwIndexType portNum, 
          Fw::Success& condition 
      );

      Fw::Buffer framedAllocate_out(
          FwIndexType portNum, 
          U32 size 
      );

      Drv::SendStatus framedOut_out(
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      );

    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_bufferIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

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

      static void m_p_comStatusIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Success& condition 
      );

    PRIVATE:

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

      Fw::InputBufferSendPort m_bufferIn_InputPort[NUM_BUFFERIN_INPUT_PORTS];

      Fw::InputComPort m_comIn_InputPort[NUM_COMIN_INPUT_PORTS];

      Fw::InputSuccessConditionPort m_comStatusIn_InputPort[NUM_COMSTATUSIN_INPUT_PORTS];

    PRIVATE:

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

      Fw::OutputBufferSendPort m_bufferDeallocate_OutputPort[NUM_BUFFERDEALLOCATE_OUTPUT_PORTS];

      Fw::OutputSuccessConditionPort m_comStatusOut_OutputPort[NUM_COMSTATUSOUT_OUTPUT_PORTS];

      Fw::OutputBufferGetPort m_framedAllocate_OutputPort[NUM_FRAMEDALLOCATE_OUTPUT_PORTS];

      Drv::OutputByteStreamSendPort m_framedOut_OutputPort[NUM_FRAMEDOUT_OUTPUT_PORTS];

    PRIVATE:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif