Skip to main content

TimerControlCommand Class

Command that carries a TimerControlContext to the timer subsystem. More...

Declaration​

class helios::engine::mechanics::timing::commands::TimerControlCommand { ... }

Public Constructors Index​

TimerControlCommand (helios::engine::mechanics::timing::types::TimerControlContext timerContext)

Constructs a TimerControlCommand with the given context. More...

Public Member Functions Index​

helios::engine::mechanics::timing::types::TimerControlContexttimerControlContext () const noexcept

Returns the timer control context. More...

Private Member Attributes Index​

helios::engine::mechanics::timing::types::TimerControlContexttimerContext_

The timer control context describing the requested state transition. More...

Description​

Command that carries a TimerControlContext to the timer subsystem.

TimerControlCommand is dispatched through the command buffer to request timer state transitions (start, pause, stop).

See Also

helios::engine::mechanics::timing::types::TimerControlContext

See Also

helios::engine::mechanics::timing::TimerCommandDispatcher

Definition at line 28 of file TimerControlCommand.ixx.

Public Constructors​

TimerControlCommand()​

helios::engine::mechanics::timing::commands::TimerControlCommand::TimerControlCommand (helios::engine::mechanics::timing::types::TimerControlContext timerContext)
 inline explicit

Constructs a TimerControlCommand with the given context.

Parameters
timerContext

The context describing which timer to control and the target state.

Definition at line 42 of file TimerControlCommand.ixx.

42 explicit TimerControlCommand(
43 helios::engine::mechanics::timing::types::TimerControlContext timerContext
44 ) : timerContext_(std::move(timerContext)) { }

Public Member Functions​

timerControlContext()​

helios::engine::mechanics::timing::types::TimerControlContext helios::engine::mechanics::timing::commands::TimerControlCommand::timerControlContext ()
 inline nodiscard noexcept

Returns the timer control context.

Returns

The TimerControlContext describing the requested state transition.

Definition at line 52 of file TimerControlCommand.ixx.

52 [[nodiscard]] helios::engine::mechanics::timing::types::TimerControlContext timerControlContext() const noexcept {
53 return timerContext_;
54 }

Private Member Attributes​

timerContext_​

helios::engine::mechanics::timing::types::TimerControlContext helios::engine::mechanics::timing::commands::TimerControlCommand::timerContext_

The timer control context describing the requested state transition.

Definition at line 33 of file TimerControlCommand.ixx.

33 helios::engine::mechanics::timing::types::TimerControlContext timerContext_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.