FinalState< EventType > Class Template Reference
This is the standard implementation of FinalStateBase. More...
#include <ArmarXCore/statechart/standardstates/FinalState.h>
Inheritance diagram for FinalState< EventType >:Static Public Member Functions | |
| static StatePtr | createState (const EventPtr &event) |
| createState creates a finalstate instance with the specified event type. More... | |
| Static Public Member Functions inherited from StateTemplate< FinalState< EvDummy > > | |
| static IceInternal::Handle< StateType > | createInstance (std::string stateName="") |
| Creates a new state instance of the type of the template parameter. More... | |
Additional Inherited Members | |
| Public Types inherited from StateTemplate< FinalState< EvDummy > > | |
| using | Type = StateType |
| Public Member Functions inherited from FinalStateBase< EvDummy, FinalState< EvDummy > > | |
| RemoteStatePtr | addRemoteState (std::string stateName, std::string proxyName, std::string instanceName="") override |
| Overridden function, which always throws an exception, to forbid the usage of this function here. More... | |
| StatePtr | addState (std::string stateName) |
| Overridden function, which always throws an exception, to forbid the usage of this function here. More... | |
| FinalStateBase () | |
| Public Member Functions inherited from StateTemplate< FinalState< EvDummy > > | |
| StateBasePtr | clone () const override |
| Creates a copy of this state. More... | |
| Protected Member Functions inherited from FinalStateBase< EvDummy, FinalState< EvDummy > > | |
| void | defineParameters () override |
| void | onEnter () override |
| Protected Member Functions inherited from StateTemplate< FinalState< EvDummy > > | |
| StateTemplate () | |
| ~StateTemplate () override | |
| Protected Attributes inherited from FinalStateBase< EvDummy, FinalState< EvDummy > > | |
| EventPtr | eventToSend |
| Event that is automatically sent when this state is entered. More... | |
Detailed Description
template<class EventType = EvDummy>
class armarx::FinalState< EventType >
This is the standard implementation of FinalStateBase.
It should be used, if no additional functionality is needed. The template parameter EventType specifies the event that is automatically send, when this state is entered.
- See also
- FinalStateBase
Definition at line 145 of file FinalState.h.
Member Function Documentation
◆ createState()
createState creates a finalstate instance with the specified event type.
This function is needed if the EventType is only known at runtime.
- Parameters
-
event EventType that is automatically send in StateBase::onEnter()
- Returns
- new instance to the FinalState
Definition at line 156 of file FinalState.h.
Here is the caller graph for this function:The documentation for this class was generated from the following file:
- ArmarXCore/statechart/standardstates/FinalState.h
