List of all members | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
FiniteStateMachine< T, ChainType, StatusType, failure_status > Class Template Reference

#include <ArmarXCore/core/util/FiniteStateMachine.h>

Public Types

using state = std::function< StatusType(T *)>
 

Public Member Functions

 FiniteStateMachine (std::shared_ptr< T > context)
 
 FiniteStateMachine (T &context)
 
 FiniteStateMachine (T *context)
 
ChainType & from (state from_state)
 
ChainType & on (StatusType status)
 
ChainType & on_any_failure ()
 
ChainType & on_failure ()
 
virtual StatusType run () const
 
ChainType & start_from (state start_state)
 
ChainType & to (state to_state)
 

Static Public Attributes

static const StatusType failure_status_value = failure_status
 

Protected Member Functions

long get_id (const state &fn) const
 
long get_id (std::optional< state > fn) const
 
std::optional< state > get_next_state (const long state_id, const StatusType status) const
 

Protected Attributes

T * m_context
 
std::optional< state > m_default_fail_state
 
std::optional< state > m_init_from_state
 
std::optional< state > m_init_to_state
 
std::optional< state > m_start_state
 
std::map< long, std::optional< state > > m_states
 
std::map< std::tuple< long, StatusType >, long > m_transitions
 

Detailed Description

template<typename T, typename ChainType, typename StatusType, StatusType failure_status>
class armarx::FiniteStateMachine< T, ChainType, StatusType, failure_status >

Definition at line 40 of file FiniteStateMachine.h.

Member Typedef Documentation

◆ state

using state = std::function<StatusType(T*)>

Definition at line 44 of file FiniteStateMachine.h.

Constructor & Destructor Documentation

◆ FiniteStateMachine() [1/3]

FiniteStateMachine ( T &  context)
inline

Definition at line 57 of file FiniteStateMachine.h.

◆ FiniteStateMachine() [2/3]

FiniteStateMachine ( std::shared_ptr< T >  context)
inline

Definition at line 62 of file FiniteStateMachine.h.

◆ FiniteStateMachine() [3/3]

FiniteStateMachine ( T *  context)
inline

Definition at line 67 of file FiniteStateMachine.h.

Member Function Documentation

◆ from()

ChainType& from ( state  from_state)
inline

Definition at line 80 of file FiniteStateMachine.h.

◆ get_id() [1/2]

long get_id ( const state &  fn) const
inlineprotected

Definition at line 221 of file FiniteStateMachine.h.

◆ get_id() [2/2]

long get_id ( std::optional< state >  fn) const
inlineprotected

Definition at line 215 of file FiniteStateMachine.h.

+ Here is the caller graph for this function:

◆ get_next_state()

std::optional<state> get_next_state ( const long  state_id,
const StatusType  status 
) const
inlineprotected

Definition at line 202 of file FiniteStateMachine.h.

+ Here is the caller graph for this function:

◆ on()

ChainType& on ( StatusType  status)
inline

Definition at line 112 of file FiniteStateMachine.h.

+ Here is the caller graph for this function:

◆ on_any_failure()

ChainType& on_any_failure ( )
inline

Definition at line 150 of file FiniteStateMachine.h.

◆ on_failure()

ChainType& on_failure ( )
inline

Definition at line 144 of file FiniteStateMachine.h.

◆ run()

virtual StatusType run ( ) const
inlinevirtual

Definition at line 164 of file FiniteStateMachine.h.

◆ start_from()

ChainType& start_from ( state  start_state)
inline

Definition at line 73 of file FiniteStateMachine.h.

◆ to()

ChainType& to ( state  to_state)
inline

Definition at line 96 of file FiniteStateMachine.h.

Member Data Documentation

◆ failure_status_value

const StatusType failure_status_value = failure_status
static

Definition at line 45 of file FiniteStateMachine.h.

◆ m_context

T* m_context
mutableprotected

Definition at line 48 of file FiniteStateMachine.h.

◆ m_default_fail_state

std::optional<state> m_default_fail_state
protected

Definition at line 52 of file FiniteStateMachine.h.

◆ m_init_from_state

std::optional<state> m_init_from_state
protected

Definition at line 50 of file FiniteStateMachine.h.

◆ m_init_to_state

std::optional<state> m_init_to_state
protected

Definition at line 51 of file FiniteStateMachine.h.

◆ m_start_state

std::optional<state> m_start_state
protected

Definition at line 49 of file FiniteStateMachine.h.

◆ m_states

std::map<long, std::optional<state> > m_states
protected

Definition at line 53 of file FiniteStateMachine.h.

◆ m_transitions

std::map<std::tuple<long, StatusType>, long> m_transitions
protected

Definition at line 54 of file FiniteStateMachine.h.

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