ComAggregatorComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_ComAggregatorComponentAc_HPP
#define Svc_ComAggregatorComponentAc_HPP

#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Ports/SuccessCondition/SuccessConditionPortAc.hpp"
#include "Svc/ComAggregator/AggregationMachineStateMachineAc.hpp"
#include "Svc/Ports/CommsPorts/ComDataWithContextPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"

namespace Svc {

  class ComAggregatorComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class ComAggregatorTesterBase;
      friend class ComAggregatorTester;

    protected:

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

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

      enum {
        NUM_COMSTATUSOUT_OUTPUT_PORTS = 1,
        NUM_DATAOUT_OUTPUT_PORTS = 1,
        NUM_DATARETURNOUT_OUTPUT_PORTS = 1,
      };

      enum class SmId : FwEnumStoreType {
        aggregationMachine,
      };

    protected:

      // ----------------------------------------------------------------------
      // Types for internal state machines
      // ----------------------------------------------------------------------

      class Svc_AggregationMachine :
        public Svc::AggregationMachineStateMachineBase
      {

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

          friend class ComAggregatorTesterBase;
          friend class ComAggregatorTester;

        public:

          Svc_AggregationMachine(
              ComAggregatorComponentBase& component 
          );

        public:

          void init(
              ComAggregatorComponentBase::SmId smId 
          );

        public:

          ComAggregatorComponentBase::SmId getId() const;

        private:

          void action_doClear(
              Signal signal 
          );

          void action_doFill(
              Signal signal, 
              const Svc::ComDataContextPair& value 
          );

          void action_doSend(
              Signal signal 
          );

          void action_doHold(
              Signal signal, 
              const Svc::ComDataContextPair& value 
          );

          void action_doSplitHold(
              Signal signal, 
              const Svc::ComDataContextPair& value 
          );

          void action_doNoteFailure(
              Signal signal 
          );

          void action_assertNoStatus(
              Signal signal 
          );

        private:

          bool guard_isFull(
              Signal signal, 
              const Svc::ComDataContextPair& value 
          ) const;

          bool guard_willFill(
              Signal signal, 
              const Svc::ComDataContextPair& value 
          ) const;

          bool guard_isNotEmpty(
              Signal signal 
          ) const;

          bool guard_isGood(
              Signal signal, 
              const Fw::Success& value 
          ) const;

          bool guard_isSpanFull(
              Signal signal 
          ) const;

        private:

          ComAggregatorComponentBase& m_component;

      };

    public:

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

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

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Fw::InputSuccessConditionPort* get_comStatusIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputComDataWithContextPort* get_dataIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputComDataWithContextPort* get_dataReturnIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_timeout_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

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

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

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

#endif

#if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

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

      void set_comStatusOut_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
      // ----------------------------------------------------------------------

      ComAggregatorComponentBase(
          const char* compName = "" 
      );

      virtual ~ComAggregatorComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_comStatusIn_InputPorts() {
        return NUM_COMSTATUSIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataIn_InputPorts() {
        return NUM_DATAIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dataReturnIn_InputPorts() {
        return NUM_DATARETURNIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_timeout_InputPorts() {
        return NUM_TIMEOUT_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_comStatusOut_OutputPorts() {
        return NUM_COMSTATUSOUT_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 typed output ports
      // ----------------------------------------------------------------------

      bool isConnected_comStatusOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_dataOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_dataReturnOut_OutputPort(
          FwIndexType portNum 
      ) const;

    protected:

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

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

      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;

      virtual void timeout_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

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

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

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

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

      void timeout_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

    protected:

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

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

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

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

    protected:

      // ----------------------------------------------------------------------
      // State getter functions
      // ----------------------------------------------------------------------

      Svc_AggregationMachine::State aggregationMachine_getState() const;

    protected:

      // ----------------------------------------------------------------------
      // Signal send functions
      // ----------------------------------------------------------------------

      void aggregationMachine_sendSignal_timeout();

      void aggregationMachine_sendSignal_fill(
          const Svc::ComDataContextPair& value 
      );

      void aggregationMachine_sendSignal_status(
          const Fw::Success& value 
      );

    protected:

      // ----------------------------------------------------------------------
      // Functions to implement for internal state machine actions
      // ----------------------------------------------------------------------

      virtual void Svc_AggregationMachine_action_doClear(
          SmId smId, 
          Svc_AggregationMachine::Signal signal 
      ) = 0;

      virtual void Svc_AggregationMachine_action_doFill(
          SmId smId, 
          Svc_AggregationMachine::Signal signal, 
          const Svc::ComDataContextPair& value 
      ) = 0;

      virtual void Svc_AggregationMachine_action_doSend(
          SmId smId, 
          Svc_AggregationMachine::Signal signal 
      ) = 0;

      virtual void Svc_AggregationMachine_action_doHold(
          SmId smId, 
          Svc_AggregationMachine::Signal signal, 
          const Svc::ComDataContextPair& value 
      ) = 0;

      virtual void Svc_AggregationMachine_action_doSplitHold(
          SmId smId, 
          Svc_AggregationMachine::Signal signal, 
          const Svc::ComDataContextPair& value 
      ) = 0;

      virtual void Svc_AggregationMachine_action_doNoteFailure(
          SmId smId, 
          Svc_AggregationMachine::Signal signal 
      ) = 0;

      virtual void Svc_AggregationMachine_action_assertNoStatus(
          SmId smId, 
          Svc_AggregationMachine::Signal signal 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Functions to implement for internal state machine guards
      // ----------------------------------------------------------------------

      virtual bool Svc_AggregationMachine_guard_isFull(
          SmId smId, 
          Svc_AggregationMachine::Signal signal, 
          const Svc::ComDataContextPair& value 
      ) const = 0;

      virtual bool Svc_AggregationMachine_guard_willFill(
          SmId smId, 
          Svc_AggregationMachine::Signal signal, 
          const Svc::ComDataContextPair& value 
      ) const = 0;

      virtual bool Svc_AggregationMachine_guard_isNotEmpty(
          SmId smId, 
          Svc_AggregationMachine::Signal signal 
      ) const = 0;

      virtual bool Svc_AggregationMachine_guard_isGood(
          SmId smId, 
          Svc_AggregationMachine::Signal signal, 
          const Fw::Success& value 
      ) const = 0;

      virtual bool Svc_AggregationMachine_guard_isSpanFull(
          SmId smId, 
          Svc_AggregationMachine::Signal signal 
      ) const = 0;

    private:

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

      virtual MsgDispatchStatus doDispatch();

    private:

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

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

      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
      );

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

    private:

      // ----------------------------------------------------------------------
      // Send signal helper functions
      // ----------------------------------------------------------------------

      void sendSignalStart(
          SmId smId, 
          FwEnumStoreType signal, 
          Fw::SerialBufferBase& buffer 
      );

      void aggregationMachine_sendSignalFinish(
          Fw::LinearBufferBase& buffer 
      );

    private:

      // ----------------------------------------------------------------------
      // Helper functions for state machine dispatch
      // ----------------------------------------------------------------------

      void smDispatch(
          Fw::SerialBufferBase& buffer 
      );

      static void deserializeSmIdAndSignal(
          Fw::SerialBufferBase& buffer, 
          FwEnumStoreType& smId, 
          FwEnumStoreType& signal 
      );

      void Svc_AggregationMachine_smDispatch(
          Fw::SerialBufferBase& buffer, 
          Svc_AggregationMachine& sm, 
          Svc_AggregationMachine::Signal signal 
      );

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::InputSuccessConditionPort m_comStatusIn_InputPort[NUM_COMSTATUSIN_INPUT_PORTS];

      Svc::InputComDataWithContextPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

      Svc::InputComDataWithContextPort m_dataReturnIn_InputPort[NUM_DATARETURNIN_INPUT_PORTS];

      Svc::InputSchedPort m_timeout_InputPort[NUM_TIMEOUT_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::OutputSuccessConditionPort m_comStatusOut_OutputPort[NUM_COMSTATUSOUT_OUTPUT_PORTS];

      Svc::OutputComDataWithContextPort m_dataOut_OutputPort[NUM_DATAOUT_OUTPUT_PORTS];

      Svc::OutputComDataWithContextPort m_dataReturnOut_OutputPort[NUM_DATARETURNOUT_OUTPUT_PORTS];

#endif

    private:

      // ----------------------------------------------------------------------
      // State machine instances
      // ----------------------------------------------------------------------

      Svc_AggregationMachine m_stateMachine_aggregationMachine;

  };

}

#endif