The DtAssistantSyncPtUpdateMsg defines a wrapper for the RTI Assistant synchronization point update message used by an rtiexec to inform the Assistant of the current state of a single synchronization point. More...

Inheritance diagram for DtAssistantSyncPtUpdateMsg:

Collaboration diagram for DtAssistantSyncPtUpdateMsg:

List of all members.

Public Member Functions
	DtAssistantSyncPtUpdateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantSyncPtUpdateMsg (const DtNetAssistantSyncPtUpdateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantSyncPtUpdateMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual bool	isRemoval () const
	Get whether or not this sync point is being removed.
virtual void	setIsRemoval (bool remove)
	Set whether or not this sync point is being removed.
virtual void	getPendingAndAchieved (DtPendingAchievedPair &pendAchieve) const
	Return the lists of pending and achieved federates.
virtual void	setPendingAndAchieved (const DtPendingAchievedPair &pendAchieve)
	Set the lists of pending and achieved federates.
virtual MAKRti::DtString	federationName () const
	Get the federation name.
virtual void	setFederationName (const MAKRti::DtString &name)
	Set the federation name.
virtual MAKRti::DtString	syncPtName () const
	Get the sync point name.
virtual void	setSyncPtName (const MAKRti::DtString &name)
	Set the sync point name.
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 (DtRtiAssistantServer conn, DtAssistantSyncPtUpdateCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantSyncPtUpdateCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantSyncPtUpdateCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantSyncPtUpdateCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantSyncPtUpdateMsg *	netAssistantSyncPtUpdateMsg ()
	The network representation for the message.
virtual const DtNetAssistantSyncPtUpdateMsg *	netAssistantSyncPtUpdateMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantSyncPtUpdateMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setNumPending (unsigned num)
	Set/Get the number of pending federates.
virtual unsigned	numPending () const
virtual const DtNetU32 *	pendingPtr () const
	Return pointer to the pending federates location in message.
virtual DtNetU32 *	pendingPtr ()
virtual void	setNumAchieved (unsigned num)
	Set/Get the number of achieved federates.
virtual unsigned	numAchieved () const
virtual const DtNetU32 *	achievedPtr () const
	Return pointer to the achieved federates location in message.
virtual DtNetU32 *	achievedPtr ()
virtual void	setFederationNameSize (unsigned size)
	Set/Get federation name size.
virtual unsigned	federationNameSize () const
virtual const char *	federationNamePtr () const
	Return pointer to federation name location in message.
virtual char *	federationNamePtr ()
virtual void	setSyncPtNameSize (unsigned size)
	Set/Get sync point name size.
virtual unsigned	syncPtNameSize () const
virtual const char *	syncPtNamePtr () const
	Return pointer to sync point name location in message.
virtual char *	syncPtNamePtr ()

Detailed Description

The DtAssistantSyncPtUpdateMsg defines a wrapper for the RTI Assistant synchronization point update message used by an rtiexec to inform the Assistant of the current state of a single synchronization point.

Constructor & Destructor Documentation

DtAssistantSyncPtUpdateMsg::DtAssistantSyncPtUpdateMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantSyncPtUpdateMsg::DtAssistantSyncPtUpdateMsg	(	const DtNetAssistantSyncPtUpdateMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantSyncPtUpdateMsg::~DtAssistantSyncPtUpdateMsg ( ) [virtual]

Destructor.

Member Function Documentation

const DtNetU32 * DtAssistantSyncPtUpdateMsg::achievedPtr ( ) const [protected, virtual]

Return pointer to the achieved federates location in message.

References numPending(), and pendingPtr().

Referenced by federationNamePtr(), getPendingAndAchieved(), and setPendingAndAchieved().

DtNetU32 * DtAssistantSyncPtUpdateMsg::achievedPtr ( ) [protected, virtual]

References numPending(), and pendingPtr().

void DtAssistantSyncPtUpdateMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantSyncPtUpdateCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantSyncPtUpdateMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr().

void DtAssistantSyncPtUpdateMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantSyncPtUpdateCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantSyncPtUpdateMsgKind.

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

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

Implements DtAssistantMsg.

References DtAssistantSyncPtUpdateMsg(), and netAssistantSyncPtUpdateMsg().

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

Creators.

References DtAssistantSyncPtUpdateMsg().

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

References DtAssistantSyncPtUpdateMsg().

DtString DtAssistantSyncPtUpdateMsg::federationName ( ) const [virtual]

Get the federation name.

References federationNamePtr(), and federationNameSize().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processSyncPtStateMsg().

const char * DtAssistantSyncPtUpdateMsg::federationNamePtr ( ) const [protected, virtual]

Return pointer to federation name location in message.

References achievedPtr(), and numAchieved().

Referenced by federationName(), setFederationName(), and syncPtNamePtr().

char * DtAssistantSyncPtUpdateMsg::federationNamePtr ( ) [protected, virtual]

References achievedPtr(), and numAchieved().

unsigned DtAssistantSyncPtUpdateMsg::federationNameSize ( ) const [protected, virtual]

References DtNetAssistantSyncPtUpdateMsg::federationNameSize, and netAssistantSyncPtUpdateMsg().

Referenced by federationName(), setFederationName(), and syncPtNamePtr().

void DtAssistantSyncPtUpdateMsg::getPendingAndAchieved ( DtPendingAchievedPair & pendAchieve ) const [virtual]

Return the lists of pending and achieved federates.

References achievedPtr(), numAchieved(), numPending(), and pendingPtr().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processSyncPtStateMsg().

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

Returns the kind of a DtAssistantSyncPtUpdateMsg message.

Implements DtAssistantMsg.

References DtAssistantSyncPtUpdateMsgKind.

Referenced by DtAssistantSyncPtUpdateMsg().

bool DtAssistantSyncPtUpdateMsg::isRemoval ( ) const [virtual]

Get whether or not this sync point is being removed.

References DtNetAssistantSyncPtUpdateMsg::isRemoval, and netAssistantSyncPtUpdateMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processSyncPtStateMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantSyncPtUpdateMsg().

DtNetAssistantSyncPtUpdateMsg * DtAssistantSyncPtUpdateMsg::netAssistantSyncPtUpdateMsg ( ) [protected, virtual]

The network representation for the message.

Referenced by clone(), federationNameSize(), isRemoval(), numAchieved(), numPending(), pendingPtr(), setFederationNameSize(), setIsRemoval(), setNumAchieved(), setNumPending(), setSyncPtNameSize(), and syncPtNameSize().

const DtNetAssistantSyncPtUpdateMsg * DtAssistantSyncPtUpdateMsg::netAssistantSyncPtUpdateMsg ( ) const [protected, virtual]

unsigned DtAssistantSyncPtUpdateMsg::numAchieved ( ) const [protected, virtual]

References netAssistantSyncPtUpdateMsg(), and DtNetAssistantSyncPtUpdateMsg::numAchieved.

Referenced by federationNamePtr(), getPendingAndAchieved(), and setPendingAndAchieved().

unsigned DtAssistantSyncPtUpdateMsg::numPending ( ) const [protected, virtual]

References netAssistantSyncPtUpdateMsg(), and DtNetAssistantSyncPtUpdateMsg::numPending.

Referenced by achievedPtr(), getPendingAndAchieved(), and setPendingAndAchieved().

const DtNetU32 * DtAssistantSyncPtUpdateMsg::pendingPtr ( ) const [protected, virtual]

Return pointer to the pending federates location in message.

References netAssistantSyncPtUpdateMsg().

Referenced by achievedPtr(), getPendingAndAchieved(), and setPendingAndAchieved().

DtNetU32 * DtAssistantSyncPtUpdateMsg::pendingPtr ( ) [protected, virtual]

References netAssistantSyncPtUpdateMsg().

void DtAssistantSyncPtUpdateMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References federationName(), getPendingAndAchieved(), isRemoval(), and syncPtName().

void DtAssistantSyncPtUpdateMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantSyncPtUpdateCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantSyncPtUpdateMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr().

void DtAssistantSyncPtUpdateMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantSyncPtUpdateCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantSyncPtUpdateMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantSyncPtUpdateMsg::setFederationName ( const MAKRti::DtString & name ) [virtual]

Set the federation name.

References federationNamePtr(), federationNameSize(), rti1516e::insertBytes(), and setFederationNameSize().

Referenced by DtRtiAssistantExecClient::sendSyncPtUpdateMsg().

void DtAssistantSyncPtUpdateMsg::setFederationNameSize ( unsigned size ) [protected, virtual]

Set/Get federation name size.

References DtNetAssistantSyncPtUpdateMsg::federationNameSize, and netAssistantSyncPtUpdateMsg().

Referenced by setFederationName().

void DtAssistantSyncPtUpdateMsg::setIsRemoval ( bool remove ) [virtual]

Set whether or not this sync point is being removed.

References DtNetAssistantSyncPtUpdateMsg::isRemoval, and netAssistantSyncPtUpdateMsg().

Referenced by DtRtiAssistantExecClient::sendSyncPtUpdateMsg().

void DtAssistantSyncPtUpdateMsg::setNumAchieved ( unsigned num ) [protected, virtual]

Set/Get the number of achieved federates.

References netAssistantSyncPtUpdateMsg(), and DtNetAssistantSyncPtUpdateMsg::numAchieved.

Referenced by setPendingAndAchieved().

void DtAssistantSyncPtUpdateMsg::setNumPending ( unsigned num ) [protected, virtual]

Set/Get the number of pending federates.

References netAssistantSyncPtUpdateMsg(), and DtNetAssistantSyncPtUpdateMsg::numPending.

Referenced by setPendingAndAchieved().

void DtAssistantSyncPtUpdateMsg::setPendingAndAchieved ( const DtPendingAchievedPair & pendAchieve ) [virtual]

Set the lists of pending and achieved federates.

References achievedPtr(), rti1516e::insertBytes(), numAchieved(), numPending(), pendingPtr(), setNumAchieved(), and setNumPending().

Referenced by DtRtiAssistantExecClient::sendSyncPtUpdateMsg().

void DtAssistantSyncPtUpdateMsg::setSyncPtName ( const MAKRti::DtString & name ) [virtual]

Set the sync point name.

References rti1516e::insertBytes(), setSyncPtNameSize(), syncPtNamePtr(), and syncPtNameSize().

Referenced by DtRtiAssistantExecClient::sendSyncPtUpdateMsg().

void DtAssistantSyncPtUpdateMsg::setSyncPtNameSize ( unsigned size ) [protected, virtual]

Set/Get sync point name size.

References netAssistantSyncPtUpdateMsg(), and DtNetAssistantSyncPtUpdateMsg::syncPtNameSize.

Referenced by setSyncPtName().

DtString DtAssistantSyncPtUpdateMsg::syncPtName ( ) const [virtual]

Get the sync point name.

References syncPtNamePtr(), and syncPtNameSize().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processSyncPtStateMsg().

const char * DtAssistantSyncPtUpdateMsg::syncPtNamePtr ( ) const [protected, virtual]

Return pointer to sync point name location in message.

References federationNamePtr(), and federationNameSize().

Referenced by setSyncPtName(), and syncPtName().

char * DtAssistantSyncPtUpdateMsg::syncPtNamePtr ( ) [protected, virtual]

References federationNamePtr(), and federationNameSize().

unsigned DtAssistantSyncPtUpdateMsg::syncPtNameSize ( ) const [protected, virtual]

References netAssistantSyncPtUpdateMsg(), and DtNetAssistantSyncPtUpdateMsg::syncPtNameSize.

Referenced by setSyncPtName(), and syncPtName().

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