DtAssistantTimeStateMsg Class Reference

The DtAssistantTimeStateMsg defines a wrapper for the RTI Assistant federation time state message used by the rtiexec to inform the Assistant of the current time state of all the federates in the federation. More...

Inheritance diagram for DtAssistantTimeStateMsg:

Collaboration diagram for DtAssistantTimeStateMsg:

Public Member Functions
	DtAssistantTimeStateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantTimeStateMsg (const DtNetAssistantTimeStateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantTimeStateMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual MAKRti::DtString	federationName () const
	Get the federation name for this federate.
virtual void	setFederationName (const MAKRti::DtString &name)
	Set the federation name for this federate.
virtual void	getFederateTimeStates (DtFederateInfoByHandleMap &federates) const
	Get the time state of all federates.
virtual void	setFederateTimeStates (const DtFederateInfoByHandleMap &federates)
	Set the time state of all federate.
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, DtAssistantTimeStateCb cb, void *usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer *conn, DtAssistantTimeStateCb 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 DtNetAssistantTimeStateMsg *	netAssistantTimeStateMsg ()
	The network representation for the message.
virtual const DtNetAssistantTimeStateMsg *	netAssistantTimeStateMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantTimeStateMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setNumFederates (unsigned num)
	Get/set the number of federates whose time state info is included in this message.
virtual unsigned	numFederates () const
virtual DtNetU32 *	federateHdlsPtr ()
	Return pointer to the federate handles location in message.
virtual const DtNetU32 *	federateHdlsPtr () const
virtual DtNetU8 *	regulatingPtr ()
	Return pointer to the regulating values location in message.
virtual const DtNetU8 *	regulatingPtr () const
virtual DtNetU8 *	constrainedPtr ()
	Return pointer to the constrained values location in message.
virtual const DtNetU8 *	constrainedPtr () const
virtual void	setLbtsStringsSize (unsigned size)
	Set/Get the LBTS strings size.
virtual unsigned	lbtsStringsSize () const
virtual const char *	lbtsStringsPtr () const
	Return pointer to LBTS strings location in message.
virtual char *	lbtsStringsPtr ()
virtual void	setLookAheadStringsSize (unsigned size)
	Set/Get the look ahead strings size.
virtual unsigned	lookAheadStringsSize () const
virtual const char *	lookAheadStringsPtr () const
	Return pointer to look ahead strings location in message.
virtual char *	lookAheadStringsPtr ()
virtual void	setTimeStringsSize (unsigned size)
	Set/Get the time strings size.
virtual unsigned	timeStringsSize () const
virtual const char *	timeStringsPtr () const
	Return pointer to time strings location in message.
virtual char *	timeStringsPtr ()
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 ()
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 DtAssistantTimeStateMsg defines a wrapper for the RTI Assistant federation time state message used by the rtiexec to inform the Assistant of the current time state of all the federates in the federation.

Constructor & Destructor Documentation

DtAssistantTimeStateMsg::DtAssistantTimeStateMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtAssistantTimeStateMsg::DtAssistantTimeStateMsg	(	const DtNetAssistantTimeStateMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

virtual DtAssistantTimeStateMsg::~DtAssistantTimeStateMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantTimeStateMsg::addCallback ( DtRtiAssistantServer *  conn, DtAssistantTimeStateCb  cb, void *  usr  )

static

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

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

virtual

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

Implements DtAssistantMsg.

virtual DtNetU8* DtAssistantTimeStateMsg::constrainedPtr ( )

protectedvirtual

Return pointer to the constrained values location in message.

virtual const DtNetU8* DtAssistantTimeStateMsg::constrainedPtr ( ) const

protectedvirtual

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

static

Creators.

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

static

virtual DtNetU32* DtAssistantTimeStateMsg::federateHdlsPtr ( )

protectedvirtual

Return pointer to the federate handles location in message.

virtual const DtNetU32* DtAssistantTimeStateMsg::federateHdlsPtr ( ) const

protectedvirtual

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

virtual

Get the federation name for this federate.

virtual const char* DtAssistantTimeStateMsg::federationNamePtr ( ) const

protectedvirtual

Return pointer to federation name location in message.

virtual char* DtAssistantTimeStateMsg::federationNamePtr ( )

protectedvirtual

virtual unsigned DtAssistantTimeStateMsg::federationNameSize ( ) const

protectedvirtual

virtual void DtAssistantTimeStateMsg::getFederateTimeStates ( DtFederateInfoByHandleMap &  federates ) const

virtual

Get the time state of all federates.

virtual DtAssistantMsgKind DtAssistantTimeStateMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantTimeStateMsg message.

Implements DtAssistantMsg.

virtual const char* DtAssistantTimeStateMsg::lbtsStringsPtr ( ) const

protectedvirtual

Return pointer to LBTS strings location in message.

virtual char* DtAssistantTimeStateMsg::lbtsStringsPtr ( )

protectedvirtual

virtual unsigned DtAssistantTimeStateMsg::lbtsStringsSize ( ) const

protectedvirtual

virtual const char* DtAssistantTimeStateMsg::lookAheadStringsPtr ( ) const

protectedvirtual

Return pointer to look ahead strings location in message.

virtual char* DtAssistantTimeStateMsg::lookAheadStringsPtr ( )

protectedvirtual

virtual unsigned DtAssistantTimeStateMsg::lookAheadStringsSize ( ) const

protectedvirtual

virtual int DtAssistantTimeStateMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantTimeStateMsg* DtAssistantTimeStateMsg::netAssistantTimeStateMsg ( )

protectedvirtual

The network representation for the message.

virtual const DtNetAssistantTimeStateMsg* DtAssistantTimeStateMsg::netAssistantTimeStateMsg ( ) const

protectedvirtual

virtual unsigned DtAssistantTimeStateMsg::numFederates ( ) const

protectedvirtual

virtual void DtAssistantTimeStateMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

virtual DtNetU8* DtAssistantTimeStateMsg::regulatingPtr ( )

protectedvirtual

Return pointer to the regulating values location in message.

virtual const DtNetU8* DtAssistantTimeStateMsg::regulatingPtr ( ) const

protectedvirtual

static void DtAssistantTimeStateMsg::removeCallback ( DtRtiAssistantServer *  conn, DtAssistantTimeStateCb  cb, void *  usr  )

static

virtual void DtAssistantTimeStateMsg::setFederateTimeStates ( const DtFederateInfoByHandleMap &  federates )

virtual

Set the time state of all federate.

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

virtual

Set the federation name for this federate.

virtual void DtAssistantTimeStateMsg::setFederationNameSize ( unsigned  size )

protectedvirtual

Set/Get federation name size.

virtual void DtAssistantTimeStateMsg::setLbtsStringsSize ( unsigned  size )

protectedvirtual

Set/Get the LBTS strings size.

virtual void DtAssistantTimeStateMsg::setLookAheadStringsSize ( unsigned  size )

protectedvirtual

Set/Get the look ahead strings size.

virtual void DtAssistantTimeStateMsg::setNumFederates ( unsigned  num )

protectedvirtual

Get/set the number of federates whose time state info is included in this message.

virtual void DtAssistantTimeStateMsg::setTimeStringsSize ( unsigned  size )

protectedvirtual

Set/Get the time strings size.

virtual const char* DtAssistantTimeStateMsg::timeStringsPtr ( ) const

protectedvirtual

Return pointer to time strings location in message.

virtual char* DtAssistantTimeStateMsg::timeStringsPtr ( )

protectedvirtual

virtual unsigned DtAssistantTimeStateMsg::timeStringsSize ( ) const

protectedvirtual

---

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

• assistantTimeStateMsg.h