DtVrfObjectMessageExecutive Class Reference

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

Public Member Functions
	DtVrfObjectMessageExecutive ()
virtual	~DtVrfObjectMessageExecutive ()
virtual void	processMessage (const DtVrfObjectMessage *message)
virtual void	removeAllCallbacks ()
virtual void	addMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
virtual void	removeMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
template<typename messageType >
void	addMessageCallback (const messageType &type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
template<typename messageType >
void	removeMessageCallback (const messageType &type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
virtual void	addMessageCallbackByCategory (int category, DtVrfObjectMessageCallbackFcn fcn, void *usr)
virtual void	removeMessageCallbackByCategory (int category, DtVrfObjectMessageCallbackFcn fcn, void *usr)

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

Protected Attributes
DtVrfObjectMessageTypeCallbackMap	myVrfObjectMessageCallbacks
DtObjectMessageCallbackList	myObjectMessageCallbacks
DtObjectMessageCategoryCallbackMap	myObjectMessageCallbacksByCategory

Private Member Functions
	DtVrfObjectMessageExecutive (const DtVrfObjectMessageExecutive &orig)
DtVrfObjectMessageExecutive &	operator= (const DtVrfObjectMessageExecutive &orig)

Member Typedef Documentation

typedef DtCallbackList<const DtVrfObjectMessage*> DtVrfObjectMessageExecutive::DtObjectMessageCallbackList

protected

typedef std::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

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

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

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.

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

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::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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmsgs/vrfObjectMessageExecutive.h