The DtAssistantChangeLatencyTestModeMsg defines a wrapper for the RTI Assistant initiate latency test message used by the Assistant to command an RTI component to initiate a latency test. More...

Inheritance diagram for DtAssistantChangeLatencyTestModeMsg:

Collaboration diagram for DtAssistantChangeLatencyTestModeMsg:

Public Member Functions
	DtAssistantChangeLatencyTestModeMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantChangeLatencyTestModeMsg (const DtNetAssistantChangeLatencyTestModeMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantChangeLatencyTestModeMsg (bool continuous, bool shouldHalt, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor specifying netHeader variables.
virtual	~DtAssistantChangeLatencyTestModeMsg ()
	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.
virtual bool	runTest () const
	Set/Get Is this a request to start a new test?
virtual void	setRunTest (bool yesNo)
virtual bool	continuousUpdate () const
	Set/Get Is this request start/stop a continuous test?
virtual void	setContinuousUpdate (bool yesNo)
virtual bool	shouldHaltContinuous () const
	Set / Get Is this halt Continuous msg? Irrelevant if continuousUpdate returns false.
virtual void	setShouldHaltContinuous (bool yesNo)
virtual bool	observingResults () const
	Set / Get are we observing test results?
virtual void	setObservingResults (bool yesNo)
virtual unsigned int	interactionPeriod () const
	Set / Get the period between interactions (in ms).
virtual void	setInteractionPeriod (unsigned int period)
virtual unsigned int	numInteractions () const
	Set / Get the number of interactions to send in this test.
virtual void	setNumInteractions (unsigned int num)
virtual unsigned int	payloadBytes () const
	Set / Get the number of bytes in the interaction payload.
virtual void	setPayloadBytes (unsigned int bytes)
virtual unsigned long	federationHandle () const
	Set / Get the handle of the federation to be tested.
virtual void	setFederationHandle (unsigned long handle)
virtual unsigned long	initFedHandle () const
	Set / Get the handle of the initiating federate.
virtual void	setInitFedHandle (unsigned long handle)
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 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)

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, DtAssistantChangeLatencyTestModeCb cb, void usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantClient conn, DtAssistantChangeLatencyTestModeCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantChangeLatencyTestModeCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantChangeLatencyTestModeCb 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 DtNetAssistantChangeLatencyTestModeMsg *	netAssistantChangeLatencyTestModeMsg ()
	The network representation for the message.
virtual const DtNetAssistantChangeLatencyTestModeMsg *	netAssistantChangeLatencyTestModeMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantChangeLatencyTestModeMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
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 DtAssistantChangeLatencyTestModeMsg defines a wrapper for the RTI Assistant initiate latency test message used by the Assistant to command an RTI component to initiate a latency test.

Constructor & Destructor Documentation

DtAssistantChangeLatencyTestModeMsg::DtAssistantChangeLatencyTestModeMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantChangeLatencyTestModeMsg::DtAssistantChangeLatencyTestModeMsg	(	const DtNetAssistantChangeLatencyTestModeMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtNetAssistantChangeLatencyTestModeMsg::continuous, DtNetAssistantChangeLatencyTestModeMsg::header, DtAssistantMsg::initAssistantMsg(), setContinuousUpdate(), setShouldHaltContinuous(), and DtNetAssistantChangeLatencyTestModeMsg::shouldHaltContinuous.

DtAssistantChangeLatencyTestModeMsg::DtAssistantChangeLatencyTestModeMsg	(	bool	continuous,
		bool	shouldHalt,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

constructor specifying netHeader variables.

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

DtAssistantChangeLatencyTestModeMsg::~DtAssistantChangeLatencyTestModeMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantChangeLatencyTestModeMsg::addCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantChangeLatencyTestModeCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantChangeLatencyTestModeMsgKind.

Referenced by DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr(), DtRtiexecObserverForAssistant::DtRtiexecObserverForAssistant(), and DtTestManager::postJoinInit().

void DtAssistantChangeLatencyTestModeMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantChangeLatencyTestModeCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantChangeLatencyTestModeMsgKind.

DtAssistantMsg * DtAssistantChangeLatencyTestModeMsg::clone ( bool copy = true ) const

virtual

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

Implements DtAssistantMsg.

References DtAssistantChangeLatencyTestModeMsg(), and netAssistantChangeLatencyTestModeMsg().

bool DtAssistantChangeLatencyTestModeMsg::continuousUpdate ( ) const

virtual

Set/Get Is this request start/stop a continuous test?

References netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

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

static

Creators.

References DtAssistantChangeLatencyTestModeMsg().

DtAssistantMsg * DtAssistantChangeLatencyTestModeMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

References DtAssistantChangeLatencyTestModeMsg().

unsigned long DtAssistantChangeLatencyTestModeMsg::federationHandle ( ) const

virtual

Set / Get the handle of the federation to be tested.

Only used when sent by the assistant to an rtiexec, so that the exec initiates the test for the correct federation.

References DtNetAssistantChangeLatencyTestModeMsg::federationHandle, and netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

unsigned long DtAssistantChangeLatencyTestModeMsg::initFedHandle ( ) const

virtual

Set / Get the handle of the initiating federate.

Only used when sent by the assistant to an rtiexec, so that the exec initiates the test for the correct federate.

References DtNetAssistantChangeLatencyTestModeMsg::initFedHandle, and netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

unsigned int DtAssistantChangeLatencyTestModeMsg::interactionPeriod ( ) const

virtual

Set / Get the period between interactions (in ms).

References DtNetAssistantChangeLatencyTestModeMsg::interactionPeriod, and netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

DtAssistantMsgKind DtAssistantChangeLatencyTestModeMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantChangeLatencyTestModeMsg message.

Implements DtAssistantMsg.

References DtAssistantChangeLatencyTestModeMsgKind.

Referenced by DtAssistantChangeLatencyTestModeMsg().

int DtAssistantChangeLatencyTestModeMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantChangeLatencyTestModeMsg().

DtNetAssistantChangeLatencyTestModeMsg * DtAssistantChangeLatencyTestModeMsg::netAssistantChangeLatencyTestModeMsg ( )

protectedvirtual

The network representation for the message.

Referenced by clone(), continuousUpdate(), federationHandle(), initFedHandle(), interactionPeriod(), numInteractions(), observingResults(), payloadBytes(), runTest(), setContinuousUpdate(), setFederationHandle(), setInitFedHandle(), setInteractionPeriod(), setNumInteractions(), setObservingResults(), setPayloadBytes(), setRunTest(), setShouldHaltContinuous(), and shouldHaltContinuous().

const DtNetAssistantChangeLatencyTestModeMsg * DtAssistantChangeLatencyTestModeMsg::netAssistantChangeLatencyTestModeMsg ( ) const

protectedvirtual

unsigned int DtAssistantChangeLatencyTestModeMsg::numInteractions ( ) const

virtual

Set / Get the number of interactions to send in this test.

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::numInteractions.

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

bool DtAssistantChangeLatencyTestModeMsg::observingResults ( ) const

virtual

Set / Get are we observing test results?

References netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

unsigned int DtAssistantChangeLatencyTestModeMsg::payloadBytes ( ) const

virtual

Set / Get the number of bytes in the interaction payload.

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::payloadBytes.

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

void DtAssistantChangeLatencyTestModeMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References continuousUpdate(), federationHandle(), initFedHandle(), interactionPeriod(), numInteractions(), observingResults(), payloadBytes(), runTest(), and shouldHaltContinuous().

void DtAssistantChangeLatencyTestModeMsg::removeCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantChangeLatencyTestModeCb	cb,
		void *	usr
	)

static

References DtAssistantChangeLatencyTestModeMsgKind, and DtRtiAssistantClient::removeMsgCallback().

Referenced by DtAssistantLatencyTestMgr::~DtAssistantLatencyTestMgr(), DtRtiexecObserverForAssistant::~DtRtiexecObserverForAssistant(), and DtTestManager::~DtTestManager().

void DtAssistantChangeLatencyTestModeMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantChangeLatencyTestModeCb	cb,
		void *	usr
	)

static

References DtAssistantChangeLatencyTestModeMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

bool DtAssistantChangeLatencyTestModeMsg::runTest ( ) const

virtual

Set/Get Is this a request to start a new test?

References netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

void DtAssistantChangeLatencyTestModeMsg::setContinuousUpdate ( bool yesNo )

virtual

References DtNetAssistantChangeLatencyTestModeMsg::continuous, and netAssistantChangeLatencyTestModeMsg().

Referenced by DtAssistantChangeLatencyTestModeMsg(), DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setFederationHandle ( unsigned long handle )

virtual

References DtNetAssistantChangeLatencyTestModeMsg::federationHandle, and netAssistantChangeLatencyTestModeMsg().

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setInitFedHandle ( unsigned long handle )

virtual

References DtNetAssistantChangeLatencyTestModeMsg::initFedHandle, and netAssistantChangeLatencyTestModeMsg().

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setInteractionPeriod ( unsigned int period )

virtual

References DtNetAssistantChangeLatencyTestModeMsg::interactionPeriod, and netAssistantChangeLatencyTestModeMsg().

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setNumInteractions ( unsigned int num )

virtual

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::numInteractions.

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setObservingResults ( bool yesNo )

virtual

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::observing.

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setPayloadBytes ( unsigned int bytes )

virtual

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::payloadBytes.

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setRunTest ( bool yesNo )

virtual

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::runTest.

Referenced by DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

void DtAssistantChangeLatencyTestModeMsg::setShouldHaltContinuous ( bool yesNo )

virtual

References netAssistantChangeLatencyTestModeMsg(), and DtNetAssistantChangeLatencyTestModeMsg::shouldHaltContinuous.

Referenced by DtAssistantChangeLatencyTestModeMsg(), DtRtiAssistantServer::sendLatencyTestRequestMsg(), and DtRtiAssistantPeer::sendLatencyTestRequestMsg().

bool DtAssistantChangeLatencyTestModeMsg::shouldHaltContinuous ( ) const

virtual

Set / Get Is this halt Continuous msg? Irrelevant if continuousUpdate returns false.

References netAssistantChangeLatencyTestModeMsg().

Referenced by printData(), DtTestManager::processChangeLatencyTestStatus(), DtRtiexecObserverForAssistant::processLatencyTestCmndMsg(), and DtAssistantLatencyTestMgr::processTestCommand().

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