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:

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.
Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor.
virtual DtNetAssistantMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual DtAssistantMsgKind	msgKind () const
	Get the message kind.
virtual void	print () const
	Printing functions.
virtual void	printHeader () const
virtual void	printSrcDest () const
virtual bool	isOk () const
	Message is good?
bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants.
virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message.
virtual void	setSourceAddr (const MAKRti::DtInetAddr &addr)
virtual int	sourceId () const
	Get/Set the ID of the source of this message.
virtual void	setSourceId (int id)
virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message.
virtual void	setSourceHost (const MAKRti::DtString &addr)
virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message.
virtual void	setDestAddr (const MAKRti::DtInetAddr &addr)
virtual int	destId () const
	Get/Set the ID of the destination of this message.
virtual void	setDestId (int id)
virtual int	compId () const
	Get/Set the related component's connection ID.
virtual void	setCompId (int compId)
virtual const DtAssistantUuid &	sourceUuid () const
	Get/Set the uuid of the source of this message.
virtual void	setSourceUuid (const DtAssistantUuid &uuid)
virtual bool	isForeign () const
	Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only.
virtual void	setIsForeign (bool isForeignDestination)
virtual DtU32	sequence () const
	Get/Set sequence number Assistant-to-Assistant messages only.
virtual void	setSequence (DtU32 sequenceNumber)

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)
Static Public Member Functions inherited from DtAssistantMsg
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration.

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 ()
Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initAssistantMsg (const void *initial, int size, DtBufferPtr buffer)
void	initAssistantMsg (const DtNetAssistantMsgHeader *header, DtBufferPtr buffer)
virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated address.
virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.
virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message.
virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()
virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size.
virtual unsigned long	sourceHostSize () const
virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message.
virtual char *	sourceHostPtr ()

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.

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

virtual DtAssistantSyncPtUpdateMsg::~DtAssistantSyncPtUpdateMsg ( )

virtual

Destructor.

Member Function Documentation

virtual const DtNetU32* DtAssistantSyncPtUpdateMsg::achievedPtr ( ) const

protectedvirtual

Return pointer to the achieved federates location in message.

virtual DtNetU32* DtAssistantSyncPtUpdateMsg::achievedPtr ( )

protectedvirtual

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

static

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

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

static

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

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

virtual

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

Implements DtAssistantMsg.

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

static

Creators.

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

static

virtual MAKRti::DtString DtAssistantSyncPtUpdateMsg::federationName ( ) const

virtual

Get the federation name.

virtual const char* DtAssistantSyncPtUpdateMsg::federationNamePtr ( ) const

protectedvirtual

Return pointer to federation name location in message.

virtual char* DtAssistantSyncPtUpdateMsg::federationNamePtr ( )

protectedvirtual

virtual unsigned DtAssistantSyncPtUpdateMsg::federationNameSize ( ) const

protectedvirtual

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

virtual

Return the lists of pending and achieved federates.

virtual DtAssistantMsgKind DtAssistantSyncPtUpdateMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantSyncPtUpdateMsg message.

Implements DtAssistantMsg.

virtual bool DtAssistantSyncPtUpdateMsg::isRemoval ( ) const

virtual

Get whether or not this sync point is being removed.

virtual int DtAssistantSyncPtUpdateMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantSyncPtUpdateMsg* DtAssistantSyncPtUpdateMsg::netAssistantSyncPtUpdateMsg ( )

protectedvirtual

The network representation for the message.

virtual const DtNetAssistantSyncPtUpdateMsg* DtAssistantSyncPtUpdateMsg::netAssistantSyncPtUpdateMsg ( ) const

protectedvirtual

virtual unsigned DtAssistantSyncPtUpdateMsg::numAchieved ( ) const

protectedvirtual

virtual unsigned DtAssistantSyncPtUpdateMsg::numPending ( ) const

protectedvirtual

virtual const DtNetU32* DtAssistantSyncPtUpdateMsg::pendingPtr ( ) const

protectedvirtual

Return pointer to the pending federates location in message.

virtual DtNetU32* DtAssistantSyncPtUpdateMsg::pendingPtr ( )

protectedvirtual

virtual void DtAssistantSyncPtUpdateMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

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

static

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

static

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

virtual

Set the federation name.

virtual void DtAssistantSyncPtUpdateMsg::setFederationNameSize ( unsigned size )

protectedvirtual

Set/Get federation name size.

virtual void DtAssistantSyncPtUpdateMsg::setIsRemoval ( bool remove )

virtual

Set whether or not this sync point is being removed.

virtual void DtAssistantSyncPtUpdateMsg::setNumAchieved ( unsigned num )

protectedvirtual

Set/Get the number of achieved federates.

virtual void DtAssistantSyncPtUpdateMsg::setNumPending ( unsigned num )

protectedvirtual

Set/Get the number of pending federates.

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

virtual

Set the lists of pending and achieved federates.

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

virtual

Set the sync point name.

virtual void DtAssistantSyncPtUpdateMsg::setSyncPtNameSize ( unsigned size )

protectedvirtual

Set/Get sync point name size.

virtual MAKRti::DtString DtAssistantSyncPtUpdateMsg::syncPtName ( ) const

virtual

Get the sync point name.

virtual const char* DtAssistantSyncPtUpdateMsg::syncPtNamePtr ( ) const

protectedvirtual

Return pointer to sync point name location in message.

virtual char* DtAssistantSyncPtUpdateMsg::syncPtNamePtr ( )

protectedvirtual

virtual unsigned DtAssistantSyncPtUpdateMsg::syncPtNameSize ( ) const

protectedvirtual

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

assistantSyncPtUpdateMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation