List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
StateTemplate Class Reference
ArmarXCore » Statecharts

#include <ArmarXCore/statechart/State.h>

Public Types

using Type = StateType
 

Public Member Functions

StateBasePtr clone () const override
 Creates a copy of this state. More...
 

Static Public Member Functions

static IceInternal::Handle< StateType > createInstance (std::string stateName="")
 Creates a new state instance of the type of the template parameter. More...
 

Protected Member Functions

 StateTemplate ()
 
 ~StateTemplate () override
 

Detailed Description

Template class from which all states with additional functionality like an overriden onEnter() function must be derived.

Definition at line 39 of file State.h.

Member Typedef Documentation

◆ Type

using Type = StateType

Definition at line 48 of file StateTemplate.h.

Constructor & Destructor Documentation

◆ StateTemplate()

StateTemplate ( )
protected

Definition at line 78 of file StateTemplate.h.

◆ ~StateTemplate()

~StateTemplate ( )
inlineoverrideprotected

Definition at line 45 of file StateTemplate.h.

Member Function Documentation

◆ clone()

StateBasePtr clone ( ) const
override

Creates a copy of this state.

All substates and parameters are cloned as well.

Returns
New state instance

Definition at line 115 of file StateTemplate.h.

◆ createInstance()

IceInternal::Handle< StateType > createInstance ( std::string  stateName = "")
static

Creates a new state instance of the type of the template parameter.

Parameters
Thename the new state should have.
Returns
New state instance

Definition at line 95 of file StateTemplate.h.

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