FinalStateBase< EventType, StateType > Class Template Reference

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

Inheritance diagram for FinalStateBase< EventType, StateType >:

Public Member Functions
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...
template<class derivedClass >
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< StateType >
StateBasePtr	clone () const override
	Creates a copy of this state. More...

Protected Member Functions
void	defineParameters () override
void	onEnter () override
Protected Member Functions inherited from StateTemplate< StateType >
	StateTemplate ()
	~StateTemplate () override

Protected Attributes
EventPtr	eventToSend
	Event that is automatically sent when this state is entered. More...

Friends
template<class Event >
class	FinalState

Additional Inherited Members
Public Types inherited from StateTemplate< StateType >
using	Type = StateType
Static Public Member Functions inherited from StateTemplate< StateType >
static IceInternal::Handle< StateType >	createInstance (std::string stateName="")
	Creates a new state instance of the type of the template parameter. More...

Detailed Description

template<class EventType, class StateType>
class armarx::FinalStateBase< EventType, StateType >

Base class for all Finalstates. Finalstates automatically send in onEnter() an event to the grandparent state that triggers the parent state to be left.
Before sending the event the output-dictionary of the parentstate is filled. The input-dictionary of the FinalState is copied from the output-dictionary of the parent state before StateBase::onEnter(). To map from the output of the previous state to the output of the parent state, the mapping has to be specified for the transition between FinalState and the previous state.
@Note onExit() will not be called in this state.

See also

FinalState

Definition at line 48 of file FinalState.h.

Constructor & Destructor Documentation

FinalStateBase()

FinalStateBase ( )

inline

Definition at line 109 of file FinalState.h.

Member Function Documentation

addRemoteState()

RemoteStatePtr addRemoteState ( std::string  stateName, std::string  proxyName, std::string  instanceName = ""  )

inlineoverride

Overridden function, which always throws an exception, to forbid the usage of this function here.

Definition at line 130 of file FinalState.h.

addState()

StatePtr addState ( std::string  stateName )

inline

Overridden function, which always throws an exception, to forbid the usage of this function here.

Definition at line 120 of file FinalState.h.

defineParameters()

void defineParameters ( )

inlineoverrideprotected

Definition at line 81 of file FinalState.h.

onEnter()

void onEnter ( )

inlineoverrideprotected

Definition at line 98 of file FinalState.h.

Friends And Related Function Documentation

FinalState

friend class FinalState

friend

Definition at line 145 of file FinalState.h.

Member Data Documentation

eventToSend

EventPtr eventToSend

protected

Event that is automatically sent when this state is entered.

Definition at line 142 of file FinalState.h.

---

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

• ArmarXCore/statechart/standardstates/FinalState.h