ara::com::helper::MachineState< T > Class Template Reference

Machine state abstract class. More...

#include <machine_state.h>

Inheritance diagram for ara::com::helper::MachineState< T >:

Public Member Functions
	MachineState (const MachineState &)=delete
MachineState &	operator= (const MachineState &)=delete
T	GetState () const noexcept
	Get the machine state. More...
virtual void	Activate (T previousState)=0
	Activate the state. More...
void	Register (AbstractStateMachine< T > *finiteStateMachine) noexcept
	Register the state to a finite state machine (FSM) More...

Protected Member Functions
virtual void	Deactivate (T nextState)=0
	Deactivating the current state before transiting to the next state. More...
void	Transit (T nextState)
	Transit to the next state. More...
	MachineState (T state) noexcept
	Constructor. More...

Detailed Description

template<typename T>
class ara::com::helper::MachineState< T >

Machine state abstract class.

Template Parameters

T	State enumeration type

Note

A machine state is not copyable

Constructor & Destructor Documentation

MachineState()

template<typename T >

ara::com::helper::MachineState< T >::MachineState ( T  state )

inlineprotectednoexcept

Constructor.

Parameters

state

Machine state enumeration

Member Function Documentation

Activate()

template<typename T >

virtual void ara::com::helper::MachineState< T >::Activate ( T  previousState )

pure virtual

Activate the state.

Parameters

previousState

Previous state before transiting to this state

Implemented in ara::com::someip::pubsub::fsm::NotSubscribedState, ara::com::someip::pubsub::fsm::ServiceDownState, ara::com::someip::pubsub::fsm::SubscribedState, ara::com::someip::sd::fsm::ClientInitialWaitState, ara::com::someip::sd::fsm::ClientRepetitionState, ara::com::someip::sd::fsm::ServiceNotseenState, ara::com::someip::sd::fsm::ServiceReadyState, ara::com::someip::sd::fsm::ServiceSeenState, ara::com::someip::sd::fsm::StoppedState, ara::com::someip::sd::fsm::NotReadyState, ara::com::someip::sd::fsm::TimerSetState< helper::SdServerState >, and ara::com::someip::sd::fsm::TimerSetState< T >.

Deactivate()

template<typename T >

virtual void ara::com::helper::MachineState< T >::Deactivate ( T  nextState )

protectedpure virtual

Deactivating the current state before transiting to the next state.

Parameters

nextState

Next state coming after deactivation

Implemented in ara::com::someip::pubsub::fsm::NotSubscribedState, ara::com::someip::pubsub::fsm::ServiceDownState, ara::com::someip::pubsub::fsm::SubscribedState, ara::com::someip::sd::fsm::ServiceNotseenState, ara::com::someip::sd::fsm::ServiceReadyState, ara::com::someip::sd::fsm::ServiceSeenState, ara::com::someip::sd::fsm::StoppedState, ara::com::someip::sd::fsm::NotReadyState, ara::com::someip::sd::fsm::TimerSetState< helper::SdServerState >, and ara::com::someip::sd::fsm::TimerSetState< T >.

GetState()

template<typename T >

T ara::com::helper::MachineState< T >::GetState ( ) const

inlinenoexcept

Get the machine state.

Returns

Machine state enumeration

Register()

template<typename T >

void ara::com::helper::MachineState< T >::Register ( AbstractStateMachine< T > *  finiteStateMachine )

inlinenoexcept

Register the state to a finite state machine (FSM)

Parameters

finiteStateMachine

Finite state machine that contains the state

Transit()

template<typename T >

void ara::com::helper::MachineState< T >::Transit ( T  nextState )

inlineprotected

Transit to the next state.

Parameters

nextState

Next state coming after the current state