Skip to main content

StateCommand Class Template

Command that requests a state transition. More...

Declaration​

template <typename StateType> class helios::engine::state::commands::StateCommand<StateType> { ... }

Public Constructors Index​

template <typename StateType>
StateCommand (StateTransitionRequest< StateType > transitionRequest)

Constructs a state command. More...

Public Member Functions Index​

template <typename StateType>
auto transitionRequest () const noexcept -> types::StateTransitionRequest< StateType >

Returns the transition request. More...

Private Member Attributes Index​

template <typename StateType>
StateTransitionRequest< StateType >transitionRequest_

The transition request to process. More...

Description​

Command that requests a state transition.

Encapsulates a StateTransitionRequest and routes it through the command dispatcher to the appropriate StateManager. The command does not execute directly; instead it uses the visitor pattern via accept() to be dispatched.

Template Parameters
StateType

The state enum type.

See Also

StateTransitionRequest

See Also

StateCommandDispatcher

See Also

StateManager

Definition at line 36 of file StateCommand.ixx.

Public Constructors​

StateCommand()​

template <typename StateType>
helios::engine::state::commands::StateCommand< StateType >::StateCommand (StateTransitionRequest< StateType > transitionRequest)
 inline explicit

Constructs a state command.

Parameters
transitionRequest

The transition request.

Definition at line 51 of file StateCommand.ixx.

51 explicit StateCommand(StateTransitionRequest<StateType> transitionRequest)
52 : transitionRequest_(transitionRequest) {}

Reference helios::engine::state::commands::StateCommand< StateType >::transitionRequest.

Public Member Functions​

transitionRequest()​

template <typename StateType>
types::StateTransitionRequest< StateType > helios::engine::state::commands::StateCommand< StateType >::transitionRequest ()
 inline nodiscard noexcept

Returns the transition request.

Returns

The encapsulated transition request.

Definition at line 59 of file StateCommand.ixx.

59 [[nodiscard]] types::StateTransitionRequest<StateType> transitionRequest() const noexcept {
60 return transitionRequest_;
61 }

Referenced by helios::engine::state::commands::StateCommand< StateType >::StateCommand.

Private Member Attributes​

transitionRequest_​

template <typename StateType>
StateTransitionRequest<StateType> helios::engine::state::commands::StateCommand< StateType >::transitionRequest_

The transition request to process.

Definition at line 41 of file StateCommand.ixx.

41 StateTransitionRequest<StateType> transitionRequest_;

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.