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.
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
	~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.
MessageTypeT	getEffectiveLoggingLevel () const
	Logging ()
void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
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.
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

Member Enumeration Documentation

StatechartManagerState

enum StatechartManagerState

Enumerator
eConstructed
eRunning
eShutDown

Constructor & Destructor Documentation

StatechartManager()

StatechartManager

(

)

~StatechartManager()

~StatechartManager ( )

override

Member Function Documentation

addEvent() [1/2]

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

addEvent() [2/2]

template<typename EventType>

bool addEvent ( const StateControllerPtr & receivingState )

inline

getManagerState()

StatechartManager::StatechartManagerState getManagerState

(

)

const

getToplevelState()

StatePtr getToplevelState

(

)

const

isRunning()

bool isRunning

(

)

const

isShutdown()

bool isShutdown

(

)

const

processEvents()

void processEvents ( )

protectedvirtual

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.

shutdown()

void shutdown

(

)

start()

void start

(

bool

enterToplevelState = true

)

wakeUp()

void wakeUp

(

)

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

---

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

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