DtChangeLatencyTestModeMsg Class Reference

The DtChangeLatencyTestModeMsg defines a wrapper for the change latency test message used to command an LRC to initiate a latency test, stop a test, or inform it that the we want to observe the test results. More...

Inheritance diagram for DtChangeLatencyTestModeMsg:

Collaboration diagram for DtChangeLatencyTestModeMsg:

List of all members.

Public Member Functions
	DtChangeLatencyTestModeMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtChangeLatencyTestModeMsg (const DtNetChangeLatencyTestModeMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtChangeLatencyTestModeMsg (bool continuous, bool shouldHalt, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor specifying netHeader variables.
virtual	~DtChangeLatencyTestModeMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) 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 DtFederateHandle	initiator () const
	Set/Get handle of the federate to initiate the test.
virtual void	setInitiator (DtFederateHandle handle)
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)
Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtChangeLatencyTestModeCb cb, void *usr)
	Adds or removes a callback with the given connection manager for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtChangeLatencyTestModeCb cb, void *usr)
Protected Member Functions
virtual DtNetChangeLatencyTestModeMsg *	netChangeLatencyTestModeMsg ()
	The network representation for the notify message.
virtual const DtNetChangeLatencyTestModeMsg *	netChangeLatencyTestModeMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtChangeLatencyTestModeMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

The DtChangeLatencyTestModeMsg defines a wrapper for the change latency test message used to command an LRC to initiate a latency test, stop a test, or inform it that the we want to observe the test results.

---

Constructor & Destructor Documentation

DtChangeLatencyTestModeMsg::DtChangeLatencyTestModeMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().

Referenced by clone(), and create().

DtChangeLatencyTestModeMsg::DtChangeLatencyTestModeMsg	(	const DtNetChangeLatencyTestModeMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetChangeLatencyTestModeMsg::continuous, DtNetChangeLatencyTestModeMsg::header, DtRtiMsg::initDtRtiMsg(), setContinuousUpdate(), setShouldHaltContinuous(), and DtNetChangeLatencyTestModeMsg::shouldHaltContinuous.

DtChangeLatencyTestModeMsg::DtChangeLatencyTestModeMsg	(	bool	continuous,
		bool	shouldHalt,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor specifying netHeader variables.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setContinuousUpdate(), and setShouldHaltContinuous().

DtChangeLatencyTestModeMsg::~DtChangeLatencyTestModeMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtChangeLatencyTestModeMsg::addCallback	(	DtConnectionMgr *	conn,
		DtChangeLatencyTestModeCb	cb,
		void *	usr
	)		[static]

Adds or removes a callback with the given connection manager for this message type.

References DtConnectionMgr::addMsgCallback(), and DtChangeLatencyTestModeMsgKind.

Referenced by DtTestManager::postJoinInit().

DtRtiMsg * DtChangeLatencyTestModeMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtChangeLatencyTestModeMsg(), and netChangeLatencyTestModeMsg().

bool DtChangeLatencyTestModeMsg::continuousUpdate

(

)

const [virtual]

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

References netChangeLatencyTestModeMsg().

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

DtRtiMsg * DtChangeLatencyTestModeMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Creators.

References DtChangeLatencyTestModeMsg().

DtRtiMsg * DtChangeLatencyTestModeMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtChangeLatencyTestModeMsg().

DtFederateHandle DtChangeLatencyTestModeMsg::initiator

(

)

const [virtual]

Set/Get handle of the federate to initiate the test.

References DtNetChangeLatencyTestModeMsg::initiator, and netChangeLatencyTestModeMsg().

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

unsigned int DtChangeLatencyTestModeMsg::interactionPeriod

(

)

const [virtual]

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

References DtNetChangeLatencyTestModeMsg::interactionPeriod, and netChangeLatencyTestModeMsg().

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

DtRtiMsgKind DtChangeLatencyTestModeMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of a DtChangeLatencyTestModeMsg message.

Implements DtRtiMsg.

References DtChangeLatencyTestModeMsgKind.

Referenced by DtChangeLatencyTestModeMsg().

int DtChangeLatencyTestModeMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtChangeLatencyTestModeMsg().

DtNetChangeLatencyTestModeMsg * DtChangeLatencyTestModeMsg::netChangeLatencyTestModeMsg

(

)

[protected, virtual]

The network representation for the notify message.

Referenced by clone(), continuousUpdate(), initiator(), interactionPeriod(), numInteractions(), observingResults(), payloadBytes(), runTest(), setContinuousUpdate(), setInitiator(), setInteractionPeriod(), setNumInteractions(), setObservingResults(), setPayloadBytes(), setRunTest(), setShouldHaltContinuous(), and shouldHaltContinuous().

const DtNetChangeLatencyTestModeMsg * DtChangeLatencyTestModeMsg::netChangeLatencyTestModeMsg

(

)

const [protected, virtual]

unsigned int DtChangeLatencyTestModeMsg::numInteractions

(

)

const [virtual]

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

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::numInteractions.

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

bool DtChangeLatencyTestModeMsg::observingResults

(

)

const [virtual]

Set / Get are we observing test results?

References netChangeLatencyTestModeMsg().

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

unsigned int DtChangeLatencyTestModeMsg::payloadBytes

(

)

const [virtual]

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

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::payloadBytes.

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

void DtChangeLatencyTestModeMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

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

void DtChangeLatencyTestModeMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtChangeLatencyTestModeCb	cb,
		void *	usr
	)		[static]

References DtChangeLatencyTestModeMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtTestManager::~DtTestManager().

bool DtChangeLatencyTestModeMsg::runTest

(

)

const [virtual]

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

References netChangeLatencyTestModeMsg().

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

void DtChangeLatencyTestModeMsg::setContinuousUpdate

(

bool

yesNo

)

[virtual]

References DtNetChangeLatencyTestModeMsg::continuous, and netChangeLatencyTestModeMsg().

Referenced by DtFedExec::changeLatencyTestMode(), and DtChangeLatencyTestModeMsg().

void DtChangeLatencyTestModeMsg::setInitiator

(

DtFederateHandle

handle

)

[virtual]

References DtNetChangeLatencyTestModeMsg::initiator, and netChangeLatencyTestModeMsg().

Referenced by DtFedExec::changeLatencyTestMode().

void DtChangeLatencyTestModeMsg::setInteractionPeriod

(

unsigned int

period

)

[virtual]

References DtNetChangeLatencyTestModeMsg::interactionPeriod, netChangeLatencyTestModeMsg(), and period.

Referenced by DtFedExec::changeLatencyTestMode().

void DtChangeLatencyTestModeMsg::setNumInteractions

(

unsigned int

num

)

[virtual]

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::numInteractions.

Referenced by DtFedExec::changeLatencyTestMode().

void DtChangeLatencyTestModeMsg::setObservingResults

(

bool

yesNo

)

[virtual]

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::observing.

Referenced by DtFedExec::changeLatencyTestMode().

void DtChangeLatencyTestModeMsg::setPayloadBytes

(

unsigned int

bytes

)

[virtual]

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::payloadBytes.

Referenced by DtFedExec::changeLatencyTestMode().

void DtChangeLatencyTestModeMsg::setRunTest

(

bool

yesNo

)

[virtual]

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::runTest.

Referenced by DtFedExec::changeLatencyTestMode().

void DtChangeLatencyTestModeMsg::setShouldHaltContinuous

(

bool

yesNo

)

[virtual]

References netChangeLatencyTestModeMsg(), and DtNetChangeLatencyTestModeMsg::shouldHaltContinuous.

Referenced by DtFedExec::changeLatencyTestMode(), and DtChangeLatencyTestModeMsg().

bool DtChangeLatencyTestModeMsg::shouldHaltContinuous

(

)

const [virtual]

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

References netChangeLatencyTestModeMsg().

Referenced by printData(), and DtTestManager::processChangeLatencyTestStatus().

---

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

• changeLatencyTestModeMsg.h
• changeLatencyTestModeMsg.cxx