AggregationMachineStateMachineAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  AggregationMachineStateMachineAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for AggregationMachine state machine
// ======================================================================

#ifndef Svc_AggregationMachineStateMachineAc_HPP
#define Svc_AggregationMachineStateMachineAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"
#include "Fw/Types/SuccessEnumAc.hpp"
#include "Svc/ComAggregator/AggregationMachine_StateEnumAc.hpp"
#include "Svc/Ports/CommsPorts/ComDataContextPairSerializableAc.hpp"

namespace Svc {

  class AggregationMachineStateMachineBase {

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

      friend class AggregationMachineTester;

    public:

      // ----------------------------------------------------------------------
      // Types
      // ----------------------------------------------------------------------

      using State = Svc::AggregationMachine_State;

      enum class Signal : FwEnumStoreType {
        __FPRIME_INITIAL_TRANSITION,
        fill,
        status,
        timeout,
      };

    protected:

      // ----------------------------------------------------------------------
      // Constructors and Destructors
      // ----------------------------------------------------------------------

      AggregationMachineStateMachineBase();

      virtual ~AggregationMachineStateMachineBase();

    protected:

      // ----------------------------------------------------------------------
      // Initialization
      // ----------------------------------------------------------------------

      void initBase(
          const FwEnumStoreType id 
      );

    public:

      // ----------------------------------------------------------------------
      // Getter functions
      // ----------------------------------------------------------------------

      AggregationMachineStateMachineBase::State getState() const;

    public:

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

      void sendSignal_timeout();

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

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

    protected:

      // ----------------------------------------------------------------------
      // Actions
      // ----------------------------------------------------------------------

      virtual void action_doClear(
          Signal signal 
      ) = 0;

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

      virtual void action_doSend(
          Signal signal 
      ) = 0;

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

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

      virtual void action_doNoteFailure(
          Signal signal 
      ) = 0;

      virtual void action_assertNoStatus(
          Signal signal 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Guards
      // ----------------------------------------------------------------------

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

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

      virtual bool guard_isNotEmpty(
          Signal signal 
      ) const = 0;

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

      virtual bool guard_isSpanFull(
          Signal signal 
      ) const = 0;

    private:

      // ----------------------------------------------------------------------
      // State and choice entry
      // ----------------------------------------------------------------------

      void enter_FILL(
          Signal signal 
      );

      void enter_WAIT_STATUS(
          Signal signal 
      );

      void enter_SPAN_CHECK(
          Signal signal, 
          const Fw::Success& value 
      );

      void enter_IS_GOOD_STATUS(
          Signal signal, 
          const Fw::Success& value 
      );

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

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

    protected:

      // ----------------------------------------------------------------------
      // Member variables
      // ----------------------------------------------------------------------

      FwEnumStoreType m_id = 0;

      State m_state = State::__FPRIME_UNINITIALIZED;

  };

}

#endif