CounterStateTemplate< EventTypeConditionNotFulfilled, EventTypeConditionFulfilled > Class Template Reference

#include <ArmarXCore/statechart/standardstates/CounterState.h>

+ Inheritance diagram for CounterStateTemplate< EventTypeConditionNotFulfilled, EventTypeConditionFulfilled >:

Public Member Functions

void defineParameters ()
 
void onEnter ()
 
void onExit ()
 
- Public Member Functions inherited from StateTemplate< CounterStateTemplate< EvCounterNotFulfilled, EvCounterFulfilled > >
StateBasePtr clone () const override
 Creates a copy of this state. More...
 

Additional Inherited Members

- Public Types inherited from StateTemplate< CounterStateTemplate< EvCounterNotFulfilled, EvCounterFulfilled > >
using Type = StateType
 
- Static Public Member Functions inherited from StateTemplate< CounterStateTemplate< EvCounterNotFulfilled, EvCounterFulfilled > >
static IceInternal::Handle< StateType > createInstance (std::string stateName="")
 Creates a new state instance of the type of the template parameter. More...
 
- Protected Member Functions inherited from StateTemplate< CounterStateTemplate< EvCounterNotFulfilled, EvCounterFulfilled > >
 StateTemplate ()
 
 ~StateTemplate () override
 

Detailed Description

template<class EventTypeConditionNotFulfilled = EvCounterNotFulfilled, class EventTypeConditionFulfilled = EvCounterFulfilled>
class armarx::CounterStateTemplate< EventTypeConditionNotFulfilled, EventTypeConditionFulfilled >

Stateimplementation, that increments a given counter by one on the SystemObserver and installs 2 conditions with different events, which trigger on Counter-Threshold-Reached and Counter-Threshold-Not-Reached.

You can pass your own events to this State as Template parameters. The first template parameter is the Event, that should be send on Counter-Threshold-Reached and the second template parameter is the Event, that should be send on Counter-Threshold-Not-Reached.

Note
If you want to use the Standardevents, just use the typedef CounterState.
See also
CounterState

Definition at line 53 of file CounterState.h.

Member Function Documentation

◆ defineParameters()

void defineParameters ( )
inline

Definition at line 56 of file CounterState.h.

◆ onEnter()

void onEnter ( )
inline

Definition at line 64 of file CounterState.h.

+ Here is the call graph for this function:

◆ onExit()

void onExit ( )
inline

Definition at line 80 of file CounterState.h.

+ Here is the call graph for this function:

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