DtAssistantExitMsg Class Reference

The DtAssistantExitMsg defines a wrapper for the RTI Assistant exit message used by the Assistant to command an RTI component to resign and/or exit. More...

Inheritance diagram for DtAssistantExitMsg:

Collaboration diagram for DtAssistantExitMsg:

List of all members.

Public Member Functions
	DtAssistantExitMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantExitMsg (const DtNetAssistantExitMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantExitMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData () const
	Print the data section.
Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantClient *conn, DtAssistantExitCb cb, void *usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantClient *conn, DtAssistantExitCb cb, void *usr)
static void	addCallback (DtRtiAssistantPeer *conn, DtAssistantExitCb cb, void *usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer *conn, DtAssistantExitCb cb, void *usr)
Protected Member Functions
virtual DtNetAssistantExitMsg *	netAssistantExitMsg ()
	The network representation for the exit message.
virtual const DtNetAssistantExitMsg *	netAssistantExitMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantExitMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

The DtAssistantExitMsg defines a wrapper for the RTI Assistant exit message used by the Assistant to command an RTI component to resign and/or exit.

---

Constructor & Destructor Documentation

DtAssistantExitMsg::DtAssistantExitMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantExitMsg::DtAssistantExitMsg	(	const DtNetAssistantExitMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetAssistantExitMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantExitMsg::~DtAssistantExitMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtAssistantExitMsg::addCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantExitCb	cb,
		void *	usr
	)		[static]

Adds or removes a callback with the given Assistant client for this message type.

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantExitMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), DtForwarderObserverForAssistant::DtForwarderObserverForAssistant(), DtRtiAssistantClient::DtRtiAssistantClient(), DtRtiexecObserverForAssistant::DtRtiexecObserverForAssistant(), and DtFederateMgr::postJoinInit().

void DtAssistantExitMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantExitCb	cb,
		void *	usr
	)		[static]

Adds or removes a callback with the given Assistant peer for this message type.

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantExitMsgKind.

DtAssistantMsg * DtAssistantExitMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantExitMsg(), and netAssistantExitMsg().

DtAssistantMsg * DtAssistantExitMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Creators.

References DtAssistantExitMsg().

DtAssistantMsg * DtAssistantExitMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtAssistantExitMsg().

DtAssistantMsgKind DtAssistantExitMsg::internalMsgKind

(

)

[protected, virtual]

Returns the kind of a DtAssistantExitMsg message.

Implements DtAssistantMsg.

References DtAssistantExitMsgKind.

Referenced by DtAssistantExitMsg().

int DtAssistantExitMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantExitMsg().

DtNetAssistantExitMsg * DtAssistantExitMsg::netAssistantExitMsg

(

)

[protected, virtual]

The network representation for the exit message.

Referenced by clone().

const DtNetAssistantExitMsg * DtAssistantExitMsg::netAssistantExitMsg

(

)

const [protected, virtual]

void DtAssistantExitMsg::printData

(

)

const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantExitMsg::removeCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantExitCb	cb,
		void *	usr
	)		[static]

References DtAssistantExitMsgKind, and DtRtiAssistantClient::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr(), DtForwarderObserverForAssistant::~DtForwarderObserverForAssistant(), and DtRtiexecObserverForAssistant::~DtRtiexecObserverForAssistant().

void DtAssistantExitMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantExitCb	cb,
		void *	usr
	)		[static]

References DtAssistantExitMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

---

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

• assistantExitMsg.h
• assistantExitMsg.cxx