DtVrfObjectMessageExecutive Class Reference

Callback manager for DtVrfObjectMessage receipt. More...

Public Member Functions
	DtVrfObjectMessageExecutive ()
virtual	~DtVrfObjectMessageExecutive ()
virtual void	processMessage (const DtVrfObjectMessage *message)
	Call any appropriate callbacks that have been registered for this message.
virtual void	removeAllCallbacks ()
	Removes all callbacks that have been registered with this executive.
virtual void	addMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called for every message that goes though this message executive.
virtual void	removeMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
template<typename messageType >
void	addMessageCallback (const messageType &type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific type of object message is processed.
template<typename messageType >
void	removeMessageCallback (const messageType &type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
virtual void	addMessageCallbackByCategory (int category, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific category of object message is processed.
virtual void	removeMessageCallbackByCategory (int category, DtVrfObjectMessageCallbackFcn fcn, void *usr)

Protected Types
typedef DtCallbackList< const DtVrfObjectMessage * >	DtObjectMessageCallbackList
typedef DtBoost::shared_ptr < DtObjectMessageCallbackList >	DtObjectMessageCallbackListPtr
typedef std::map< int, DtObjectMessageCallbackListPtr >	DtObjectMessageCategoryCallbackMap

Protected Attributes
DtVrfObjectMessageTypeCallbackMap	myVrfObjectMessageCallbacks
DtObjectMessageCallbackList	myObjectMessageCallbacks
	Callbacks registered on all messages.
DtObjectMessageCategoryCallbackMap	myObjectMessageCallbacksByCategory
	Callbacks registered on specific categories.

Private Member Functions
	DtVrfObjectMessageExecutive (const DtVrfObjectMessageExecutive &orig)
	Not implemented.
DtVrfObjectMessageExecutive &	operator= (const DtVrfObjectMessageExecutive &orig)
	Not implemented.

Detailed Description

Callback manager for DtVrfObjectMessage receipt.

Callbacks can be registered on various attributes of a message, and will be invoked properly whenever processMessage() is called.

Member Typedef Documentation

typedef DtCallbackList<const DtVrfObjectMessage*> DtVrfObjectMessageExecutive::DtObjectMessageCallbackList

protected

typedef DtBoost::shared_ptr<DtObjectMessageCallbackList> DtVrfObjectMessageExecutive::DtObjectMessageCallbackListPtr

protected

typedef std::map<int, DtObjectMessageCallbackListPtr> DtVrfObjectMessageExecutive::DtObjectMessageCategoryCallbackMap

protected

Constructor & Destructor Documentation

DtVrfObjectMessageExecutive::DtVrfObjectMessageExecutive ( const DtVrfObjectMessageExecutive &  orig )

private

Not implemented.

DtVrfObjectMessageExecutive::DtVrfObjectMessageExecutive

(

)

virtual DtVrfObjectMessageExecutive::~DtVrfObjectMessageExecutive ( )

virtual

Member Function Documentation

DtVrfObjectMessageExecutive& DtVrfObjectMessageExecutive::operator= ( const DtVrfObjectMessageExecutive &  orig )

private

Not implemented.

virtual void DtVrfObjectMessageExecutive::processMessage ( const DtVrfObjectMessage *  message )

virtual

Call any appropriate callbacks that have been registered for this message.

virtual void DtVrfObjectMessageExecutive::addMessageCallback ( DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

Callback which is called for every message that goes though this message executive.

virtual void DtVrfObjectMessageExecutive::removeMessageCallback ( DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

template<typename messageType >

void DtVrfObjectMessageExecutive::addMessageCallback ( const messageType &  type, DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

inline

Callback which is called when a specific type of object message is processed.

The type parameter is the content type of the message based on radioMsgTypes.h

template<typename messageType >

void DtVrfObjectMessageExecutive::removeMessageCallback ( const messageType &  type, DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

inline

virtual void DtVrfObjectMessageExecutive::addMessageCallbackByCategory ( int  category, DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

Callback which is called when a specific category of object message is processed.

Categories are general message types such as: DtTaskMessageType, DtReportMessageType, DtSetDataRequestMessageType, and DtAdminMessageType.

virtual void DtVrfObjectMessageExecutive::removeMessageCallbackByCategory ( int  category, DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

virtual void DtVrfObjectMessageExecutive::removeAllCallbacks ( )

virtual

Removes all callbacks that have been registered with this executive.

Member Data Documentation

DtVrfObjectMessageTypeCallbackMap DtVrfObjectMessageExecutive::myVrfObjectMessageCallbacks

protected

DtObjectMessageCallbackList DtVrfObjectMessageExecutive::myObjectMessageCallbacks

protected

Callbacks registered on all messages.

DtObjectMessageCategoryCallbackMap DtVrfObjectMessageExecutive::myObjectMessageCallbacksByCategory

protected

Callbacks registered on specific categories.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/vrfObjectMessageExecutive.h