RTC::FsmActionListeners Class Reference

FsmActionListeners class. More...

#include <FsmActionListener.h>

Public Member Functions
	FsmActionListeners ()
	Constructor .
	~FsmActionListeners ()
	Destructor .
bool	addListener (PreFsmActionListenerType type, PreFsmActionListener *listener, bool autoclean=true)
	Add the listener.
bool	removeListener (PreFsmActionListenerType type, PreFsmActionListener *listener)
	Remove the listener.
bool	addListener (PostFsmActionListenerType type, PostFsmActionListener *listener, bool autoclean=true)
	Add the listener.
bool	removeListener (PostFsmActionListenerType type, PostFsmActionListener *listener)
	Remove the listener.
bool	addListener (FsmProfileListenerType type, FsmProfileListener *listener, bool autoclean=true)
	Add the listener.
bool	removeListener (FsmProfileListenerType type, FsmProfileListener *listener)
	Remove the listener.
bool	addListener (FsmStructureListenerType type, FsmStructureListener *listener, bool autoclean=true)
	Add the listener.
bool	removeListener (FsmStructureListenerType type, FsmStructureListener *listener)
	Remove the listener.
bool	notify (PreFsmActionListenerType type, const char *state)
bool	notify (PostFsmActionListenerType type, const char *state, ReturnCode_t ret)
bool	notify (FsmProfileListenerType type, RTC::FsmProfile &profile)
bool	notify (FsmStructureListenerType type, RTC::FsmStructure &structure)

Detailed Description

FsmActionListeners class.

Constructor & Destructor Documentation

FsmActionListeners()

RTC::FsmActionListeners::FsmActionListeners

(

)

Constructor .

~FsmActionListeners()

RTC::FsmActionListeners::~FsmActionListeners

(

)

Destructor .

Member Function Documentation

addListener() [1/4]

bool RTC::FsmActionListeners::addListener	(	FsmProfileListenerType	type,
		FsmProfileListener *	listener,
		bool	autoclean = true )

Add the listener.

Parameters

type
listener	Added listener
autoclean	true:The listener is deleted at the destructor., false:The listener is not deleted at the destructor.

Returns

addListener() [2/4]

bool RTC::FsmActionListeners::addListener	(	FsmStructureListenerType	type,
		FsmStructureListener *	listener,
		bool	autoclean = true )

Add the listener.

Parameters

type
listener	Added listener
autoclean	true:The listener is deleted at the destructor., false:The listener is not deleted at the destructor.

Returns

addListener() [3/4]

bool RTC::FsmActionListeners::addListener	(	PostFsmActionListenerType	type,
		PostFsmActionListener *	listener,
		bool	autoclean = true )

Add the listener.

Parameters

type
listener	Added listener
autoclean	true:The listener is deleted at the destructor., false:The listener is not deleted at the destructor.

Returns

addListener() [4/4]

bool RTC::FsmActionListeners::addListener	(	PreFsmActionListenerType	type,
		PreFsmActionListener *	listener,
		bool	autoclean = true )

Add the listener.

Parameters

type
listener	Added listener
autoclean	true:The listener is deleted at the destructor., false:The listener is not deleted at the destructor.

Returns

notify() [1/4]

bool RTC::FsmActionListeners::notify ( FsmProfileListenerType type, RTC::FsmProfile & profile )

inline

Parameters

type
profile	FsmProfile

Returns

References notify().

notify() [2/4]

bool RTC::FsmActionListeners::notify ( FsmStructureListenerType type, RTC::FsmStructure & structure )

inline

Parameters

type
structure

Returns

References notify().

notify() [3/4]

bool RTC::FsmActionListeners::notify ( PostFsmActionListenerType type, const char * state, ReturnCode_t ret )

inline

Parameters

type
state
ret

Returns

References notify().

notify() [4/4]

bool RTC::FsmActionListeners::notify ( PreFsmActionListenerType type, const char * state )

inline

Parameters

type
state

Returns

References notify().

Referenced by notify(), notify(), notify(), notify(), RTC::RTObject_impl::postOnFsmDo(), RTC::RTObject_impl::postOnFsmEntry(), RTC::RTObject_impl::postOnFsmExit(), RTC::RTObject_impl::postOnFsmInit(), RTC::RTObject_impl::postOnFsmStateChange(), RTC::RTObject_impl::preOnFsmDo(), RTC::RTObject_impl::preOnFsmEntry(), RTC::RTObject_impl::preOnFsmExit(), RTC::RTObject_impl::preOnFsmInit(), and RTC::RTObject_impl::preOnFsmStateChange().

removeListener() [1/4]

bool RTC::FsmActionListeners::removeListener	(	FsmProfileListenerType	type,
		FsmProfileListener *	listener )

Remove the listener.

Parameters

type
listener

Returns

removeListener() [2/4]

bool RTC::FsmActionListeners::removeListener	(	FsmStructureListenerType	type,
		FsmStructureListener *	listener )

Remove the listener.

Parameters

type
listener

Returns

removeListener() [3/4]

bool RTC::FsmActionListeners::removeListener	(	PostFsmActionListenerType	type,
		PostFsmActionListener *	listener )

Remove the listener.

Parameters

type
listener

Returns

removeListener() [4/4]

bool RTC::FsmActionListeners::removeListener	(	PreFsmActionListenerType	type,
		PreFsmActionListener *	listener )

Remove the listener.

Parameters

type
listener

Returns

---

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

• FsmActionListener.h