StatechartManager Class Reference

#include <ArmarXCore/statechart/StatechartManager.h>

Inheritance diagram for StatechartManager:

Public Types
enum	StatechartManagerState { eConstructed, eRunning, eShutDown }

Public Member Functions
bool	addEvent (const EventPtr &newEvent, const StateControllerPtr &receivingState)
template<typename EventType >
bool	addEvent (const StateControllerPtr &receivingState)
StatechartManagerState	getManagerState () const
StatePtr	getToplevelState () const
bool	isRunning () const
bool	isShutdown () const
bool	setToplevelState (const armarx::StatePtr &newToplevelState, StringVariantContainerBaseMap startParameters=StringVariantContainerBaseMap())
	setToplevelState sets the toplevel state of this manager. More...
void	shutdown ()
void	start (bool enterToplevelState=true)
	StatechartManager ()
void	wakeUp ()
	wakeUp signals the event processing thread to wake up and check for new events or shutdown conditions More...
	~StatechartManager () override
Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds. More...
MessageTypeT	getEffectiveLoggingLevel () const
	Logging ()
void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
void	setTag (const LogTag &tag)
void	setTag (const std::string &tagName)
virtual	~Logging ()

Protected Member Functions
virtual void	processEvents ()
Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const
const LogSenderPtr &	getLogSender () const
	Retrieve log sender. More...
LogSenderPtr	loghelper (const char *file, int line, const char *function) const

Additional Inherited Members
Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel
SpamFilterDataPtr	spamFilter
LogTag	tag

Detailed Description

Definition at line 40 of file StatechartManager.h.

Member Enumeration Documentation

StatechartManagerState

enum StatechartManagerState

Enumerator
eConstructed
eRunning
eShutDown

Definition at line 63 of file StatechartManager.h.

Constructor & Destructor Documentation

StatechartManager()

StatechartManager

(

)

Definition at line 34 of file StatechartManager.cpp.

Here is the call graph for this function:

~StatechartManager()

~StatechartManager ( )

override

Definition at line 42 of file StatechartManager.cpp.

Here is the call graph for this function:

Member Function Documentation

addEvent() [1/2]

bool addEvent	(	const EventPtr &	newEvent,
		const StateControllerPtr &	receivingState
	)

Definition at line 185 of file StatechartManager.cpp.

Here is the caller graph for this function:

addEvent() [2/2]

bool addEvent ( const StateControllerPtr &  receivingState )

inline

Definition at line 87 of file StatechartManager.h.

Here is the call graph for this function:

getManagerState()

StatechartManager::StatechartManagerState getManagerState

(

)

const

Definition at line 172 of file StatechartManager.cpp.

getToplevelState()

StatePtr getToplevelState

(

)

const

Definition at line 62 of file StatechartManager.cpp.

isRunning()

bool isRunning

(

)

const

Definition at line 146 of file StatechartManager.cpp.

Here is the caller graph for this function:

isShutdown()

bool isShutdown

(

)

const

Definition at line 159 of file StatechartManager.cpp.

Here is the caller graph for this function:

processEvents()

void processEvents ( )

protectedvirtual

Definition at line 218 of file StatechartManager.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setToplevelState()

bool setToplevelState	(	const armarx::StatePtr &	newToplevelState,
		StringVariantContainerBaseMap	startParameters = StringVariantContainerBaseMap()
	)

setToplevelState sets the toplevel state of this manager.

This state will be started in start().

See also

start()

Parameters

newToplevelState	Pointer to the toplevel state
startParameters	Parameters that should be given to the toplevel state on startup.

Returns

returns true if the toplevelstate was successfully set. Returns false if the StatechartManager is already running.

Definition at line 48 of file StatechartManager.cpp.

Here is the call graph for this function:

shutdown()

void shutdown

(

)

Definition at line 102 of file StatechartManager.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

start()

void start

(

bool

enterToplevelState = true

)

Definition at line 68 of file StatechartManager.cpp.

Here is the call graph for this function:

wakeUp()

void wakeUp

(

)

wakeUp signals the event processing thread to wake up and check for new events or shutdown conditions

Definition at line 179 of file StatechartManager.cpp.

---

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

• ArmarXCore/statechart/StatechartManager.h
• ArmarXCore/statechart/StatechartManager.cpp