DtFedAmbCallbackMsg Class Reference

A message that delivers stored callbacks generated by asynchronous thread. More...

Inheritance diagram for DtFedAmbCallbackMsg:

Collaboration diagram for DtFedAmbCallbackMsg:

List of all members.

Public Member Functions
	DtFedAmbCallbackMsg (std::auto_ptr< DtFedAmbCallback > callback)
	Constructor.
virtual	~DtFedAmbCallbackMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Return the message type.
virtual void	evokeCallback (RTI::FederateAmbassador *fedAmb) const
	Evoke the callback.
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print message data.
Static Public Member Functions
static void	addCallback (DtConnectionMgr *conn, DtCallbackCb cb, void *usr)
	Add a callback for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtCallbackCb cb, void *usr)
	Remove a callback for this message type.
Protected Attributes
std::auto_ptr< DtFedAmbCallback >	myCallback
	The federate ambassador callback parameters.
Private Member Functions
	DtFedAmbCallbackMsg (DtFedAmbCallbackMsg const &orig)
	Copy and Assignment Not Allowed.
DtFedAmbCallbackMsg &	operator= (DtFedAmbCallbackMsg const &orig)

---

Detailed Description

A message that delivers stored callbacks generated by asynchronous thread.

The callback message is processed in the federate's thread when it evokes tick or evokeCallback. An appropriate federate ambassador callback is made and passed the stored parameters.

---

Constructor & Destructor Documentation

DtFedAmbCallbackMsg::DtFedAmbCallbackMsg

(

std::auto_ptr< DtFedAmbCallback >

callback

)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), DtRtiMsg::myAllowedDuringSave, and myCallback.

DtFedAmbCallbackMsg::~DtFedAmbCallbackMsg

(

)

[virtual]

Destructor.

DtFedAmbCallbackMsg::DtFedAmbCallbackMsg

(

DtFedAmbCallbackMsg const &

orig

)

[private]

Copy and Assignment Not Allowed.

---

Member Function Documentation

void DtFedAmbCallbackMsg::addCallback	(	DtConnectionMgr *	conn,
		DtCallbackCb	cb,
		void *	usr
	)		[static]

Add a callback for this message type.

References DtConnectionMgr::addMsgCallback(), and DtCallbackMsgKind.

Referenced by DtAsyncConnectionMgr::init().

DtRtiMsg * DtFedAmbCallbackMsg::clone

(

bool

copy = true

)

const [virtual]

Return a copy/empty object of the same type as this.

NOTE: The transport type is not carried in the network representation used to make clones; therefore, it must be set after the clone is made

Implements DtRtiMsg.

void DtFedAmbCallbackMsg::evokeCallback

(

RTI::FederateAmbassador *

fedAmb

)

const [virtual]

Evoke the callback.

Referenced by DtAsyncConnectionMgr::processCallbackMsg().

DtRtiMsgKind DtFedAmbCallbackMsg::internalDtRtiMsgKind

(

)

[virtual]

Return the message type.

Implements DtRtiMsg.

References DtCallbackMsgKind.

Referenced by DtFedAmbCallbackMsg().

DtFedAmbCallbackMsg& DtFedAmbCallbackMsg::operator=

(

DtFedAmbCallbackMsg const &

orig

)

[private]

void DtFedAmbCallbackMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print message data.

Reimplemented from DtRtiMsg.

References myCallback.

void DtFedAmbCallbackMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtCallbackCb	cb,
		void *	usr
	)		[static]

Remove a callback for this message type.

References DtCallbackMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtAsyncConnectionMgr::~DtAsyncConnectionMgr().

---

Member Data Documentation

std::auto_ptr<DtFedAmbCallback> DtFedAmbCallbackMsg::myCallback [protected]

The federate ambassador callback parameters.

Referenced by DtFedAmbCallbackMsg(), and printData().

---

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

• fedAmbCallbackMsg.h
• fedAmbCallbackMsg.cxx