BlockDriverComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Drv_BlockDriverComponentAc_HPP
#define Drv_BlockDriverComponentAc_HPP

#include "Drv/Ports/DataTypes/DataBufferPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Fw/Types/InternalInterfaceString.hpp"
#include "Svc/Cycle/CyclePortAc.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"

namespace Drv {

  class BlockDriverComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class BlockDriverComponentBaseFriend;
      friend class BlockDriverTesterBase;

    PROTECTED:

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

      enum {
        NUM_BUFFERIN_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
        NUM_SCHED_INPUT_PORTS = 1,
      };

      enum {
        NUM_TIME_OUTPUT_PORTS = 1,
        NUM_TLM_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_BUFFEROUT_OUTPUT_PORTS = 1,
        NUM_CYCLEOUT_OUTPUT_PORTS = 1,
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        CHANNELID_BD_CYCLES = 0x0, 
      };

    public:

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

      void init(
          FwSizeType queueDepth, 
          FwEnumStoreType instance = 0 
      );

    public:

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

      Drv::InputDataBufferPort* get_BufferIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_PingIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_Sched_InputPort(
          FwIndexType portNum 
      );

    public:

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

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

      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

    public:

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

      void set_BufferOut_OutputPort(
          FwIndexType portNum, 
          Drv::InputDataBufferPort* port 
      );

      void set_CycleOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputCyclePort* port 
      );

      void set_PingOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputPingPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

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

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

#endif

#if FW_PORT_SERIALIZATION

    public:

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

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

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

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

#endif

    PROTECTED:

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

      BlockDriverComponentBase(
          const char* compName = "" 
      );

      virtual ~BlockDriverComponentBase();

    PROTECTED:

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

      FwIndexType getNum_BufferIn_InputPorts() const;

      FwIndexType getNum_PingIn_InputPorts() const;

      FwIndexType getNum_Sched_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_Time_OutputPorts() const;

      FwIndexType getNum_Tlm_OutputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_BufferOut_OutputPorts() const;

      FwIndexType getNum_CycleOut_OutputPorts() const;

      FwIndexType getNum_PingOut_OutputPorts() const;

    PROTECTED:

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

      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_Tlm_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      bool isConnected_BufferOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_CycleOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_PingOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual void BufferIn_handler(
          FwIndexType portNum, 
          Drv::DataBuffer& buff 
      ) = 0;

      virtual void PingIn_handler(
          FwIndexType portNum, 
          U32 key 
      ) = 0;

      virtual void Sched_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 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, 
          Drv::DataBuffer& buff 
      );

      void PingIn_handlerBase(
          FwIndexType portNum, 
          U32 key 
      );

      void Sched_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Pre-message hooks for typed async input ports
      //
      // Each of these functions is invoked just before processing a message
      // on the corresponding port. By default, they do nothing. You can
      // override them to provide specific pre-message behavior.
      // ----------------------------------------------------------------------

      virtual void BufferIn_preMsgHook(
          FwIndexType portNum, 
          Drv::DataBuffer& buff 
      );

      virtual void PingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

      virtual void Sched_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );

    PROTECTED:

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

      void BufferOut_out(
          FwIndexType portNum, 
          Drv::DataBuffer& buff 
      );

      void CycleOut_out(
          FwIndexType portNum, 
          Os::RawTime& cycleStart 
      );

      void PingOut_out(
          FwIndexType portNum, 
          U32 key 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Internal interface handlers
      // ----------------------------------------------------------------------

      virtual void InterruptReport_internalInterfaceHandler(
          U32 interrupt 
      ) = 0;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Internal interface base-class functions
      // ----------------------------------------------------------------------

      void InterruptReport_internalInterfaceInvoke(
          U32 interrupt 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_BD_Cycles(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    PROTECTED:

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

      Fw::Time getTime() const;

    PRIVATE:

      // ----------------------------------------------------------------------
      // Message dispatch functions
      // ----------------------------------------------------------------------

      virtual MsgDispatchStatus doDispatch();

    PRIVATE:

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

      static void m_p_BufferIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Drv::DataBuffer& buff 
      );

      static void m_p_PingIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 key 
      );

      static void m_p_Sched_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

    PRIVATE:

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

      Drv::InputDataBufferPort m_BufferIn_InputPort[NUM_BUFFERIN_INPUT_PORTS];

      Svc::InputPingPort m_PingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

      Svc::InputSchedPort m_Sched_InputPort[NUM_SCHED_INPUT_PORTS];

    PRIVATE:

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

      Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];

      Fw::OutputTlmPort m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS];

    PRIVATE:

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

      Drv::OutputDataBufferPort m_BufferOut_OutputPort[NUM_BUFFEROUT_OUTPUT_PORTS];

      Svc::OutputCyclePort m_CycleOut_OutputPort[NUM_CYCLEOUT_OUTPUT_PORTS];

      Svc::OutputPingPort m_PingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

  };

}

#endif