Gazebo Sim

API Reference

8.7.0
IsInState< TargetState > Struct Template Reference

Guard that checks whether the state machine is in a given state. More...

#include <GuardsImpl.hh>

Public Member Functions

template<typename Fsm , typename State >
bool operator() (const Fsm &_fsm, const State &)
 Function call operator. More...
 

Detailed Description

template<typename TargetState>
struct gz::sim::systems::guards::IsInState< TargetState >

Guard that checks whether the state machine is in a given state.

Note
The template parameter generalizes the target state.

Member Function Documentation

◆ operator()()

bool operator() ( const Fsm &  _fsm,
const State &   
)
inline

Function call operator.

Parameters
[in]_fsmState machine with which the guard is associated

The documentation for this struct was generated from the following files: