The DtAssistantDeleteFederateMsg defines a wrapper for the RTI Assistant delete federate command message used by the Assistant to command an rtiexec to force resign a federate. More...

Inheritance diagram for DtAssistantDeleteFederateMsg:

Collaboration diagram for DtAssistantDeleteFederateMsg:

List of all members.

Public Member Functions
	DtAssistantDeleteFederateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantDeleteFederateMsg (const DtNetAssistantDeleteFederateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantDeleteFederateMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual unsigned long	federationHandle () const
	Get the handle of the federation of the federate to be deleted.
virtual void	setFederationHandle (unsigned long handle)
	Set the handle of the federation of the federate to be deleted.
virtual unsigned long	federateHandle () const
	Get the handle of the federate to be deleted.
virtual void	setFederateHandle (unsigned long handle)
	Set the handle of the federate to be deleted.
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, DtAssistantDeleteFederateCb cb, void usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantClient conn, DtAssistantDeleteFederateCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantDeleteFederateCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantDeleteFederateCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantDeleteFederateMsg *	netAssistantDeleteFederateMsg ()
	The network representation for the delete federate message.
virtual const DtNetAssistantDeleteFederateMsg *	netAssistantDeleteFederateMsg () 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 DtAssistantDeleteFederateMsg defines a wrapper for the RTI Assistant delete federate command message used by the Assistant to command an rtiexec to force resign a federate.

Constructor & Destructor Documentation

DtAssistantDeleteFederateMsg::DtAssistantDeleteFederateMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantDeleteFederateMsg::DtAssistantDeleteFederateMsg	(	const DtNetAssistantDeleteFederateMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantDeleteFederateMsg::~DtAssistantDeleteFederateMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantDeleteFederateMsg::addCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantDeleteFederateCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantDeleteFederateMsgKind.

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

void DtAssistantDeleteFederateMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantDeleteFederateCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantDeleteFederateMsgKind.

DtAssistantMsg * DtAssistantDeleteFederateMsg::clone ( bool copy = true ) const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantDeleteFederateMsg(), and netAssistantDeleteFederateMsg().

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

Creators.

References DtAssistantDeleteFederateMsg().

DtAssistantMsg * DtAssistantDeleteFederateMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER ) [static]

References DtAssistantDeleteFederateMsg().

unsigned long DtAssistantDeleteFederateMsg::federateHandle ( ) const [virtual]

Get the handle of the federate to be deleted.

References DtNetAssistantDeleteFederateMsg::federateHandle, and netAssistantDeleteFederateMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processDeleteFederateMsg().

unsigned long DtAssistantDeleteFederateMsg::federationHandle ( ) const [virtual]

Get the handle of the federation of the federate to be deleted.

References DtNetAssistantDeleteFederateMsg::federationHandle, and netAssistantDeleteFederateMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processDeleteFederateMsg().

DtAssistantMsgKind DtAssistantDeleteFederateMsg::internalMsgKind ( ) [protected, virtual]

Returns the kind of a DtAssistantExitMsg message.

Implements DtAssistantMsg.

References DtAssistantDeleteFederateMsgKind.

Referenced by DtAssistantDeleteFederateMsg().

int DtAssistantDeleteFederateMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantDeleteFederateMsg().

DtNetAssistantDeleteFederateMsg * DtAssistantDeleteFederateMsg::netAssistantDeleteFederateMsg ( ) [protected, virtual]

The network representation for the delete federate message.

Referenced by clone(), federateHandle(), federationHandle(), setFederateHandle(), and setFederationHandle().

const DtNetAssistantDeleteFederateMsg * DtAssistantDeleteFederateMsg::netAssistantDeleteFederateMsg ( ) const [protected, virtual]

void DtAssistantDeleteFederateMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References federateHandle(), and federationHandle().

void DtAssistantDeleteFederateMsg::removeCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantDeleteFederateCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantDeleteFederateMsgKind, and DtRtiAssistantClient::removeMsgCallback().

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

void DtAssistantDeleteFederateMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantDeleteFederateCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantDeleteFederateMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantDeleteFederateMsg::setFederateHandle ( unsigned long handle ) [virtual]

Set the handle of the federate to be deleted.

References DtNetAssistantDeleteFederateMsg::federateHandle, and netAssistantDeleteFederateMsg().

Referenced by DtRtiAssistantServer::sendDeleteFederateMsg(), DtRtiAssistantServer::sendFederateResignMsg(), and DtRtiAssistantPeer::sendFederateResignMsg().

void DtAssistantDeleteFederateMsg::setFederationHandle ( unsigned long handle ) [virtual]

Set the handle of the federation of the federate to be deleted.

References DtNetAssistantDeleteFederateMsg::federationHandle, and netAssistantDeleteFederateMsg().

Referenced by DtRtiAssistantServer::sendDeleteFederateMsg(), DtRtiAssistantServer::sendFederateResignMsg(), and DtRtiAssistantPeer::sendFederateResignMsg().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation