DtTestMgrStatusMsg Class Reference

The DtTestMgrStatusMsg defines a msg for a client to report the results of a latency test. More...

Inheritance diagram for DtTestMgrStatusMsg:

Collaboration diagram for DtTestMgrStatusMsg:

List of all members.

Public Member Functions
	DtTestMgrStatusMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtTestMgrStatusMsg (int fedExHandle, int fedHandle, bool testingEnabled, bool testCapable, bool isContinuous, bool inProgress, int numInitiated, int numReports, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtTestMgrStatusMsg (const DtNetTestMgrStatusMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtTestMgrStatusMsg ()
	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	testingEnabled () const
	Is the LRC's test manager enabled?
virtual bool	testCapable () const
	Is the LRC currently capable of running a test?
virtual bool	continuousTesting () const
	Is the LRC's test manager currently running a continuous test?
virtual bool	testInProgress () const
	Is the LRC currently running a test?
virtual unsigned	numTestsInitiated () const
	Number of tests the federate has initiated.
virtual unsigned	numTestReports () const
	Number of test reports the federate has generated.
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, DtTestMgrStatusCb cb, void *usr)
	Adds or removes a callback with the given connection manager for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtTestMgrStatusCb cb, void *usr)
Protected Member Functions
virtual DtNetTestMgrStatusMsg *	netTestMgrStatusMsg ()
	The network representation for the TestMgrStatusMsg message.
virtual const DtNetTestMgrStatusMsg *	netTestMgrStatusMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtTestMgrStatusMsg message.

---

Detailed Description

The DtTestMgrStatusMsg defines a msg for a client to report the results of a latency test.

---

Constructor & Destructor Documentation

DtTestMgrStatusMsg::DtTestMgrStatusMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

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

Referenced by clone(), and create().

DtTestMgrStatusMsg::DtTestMgrStatusMsg	(	int	fedExHandle,
		int	fedHandle,
		bool	testingEnabled,
		bool	testCapable,
		bool	isContinuous,
		bool	inProgress,
		int	numInitiated,
		int	numReports,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetTestMgrStatusMsg::capable, DtNetTestMgrStatusMsg::continuous, DtNetTestMgrStatusMsg::enabled, DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), netTestMgrStatusMsg(), DtNetTestMgrStatusMsg::numInitiated, DtNetTestMgrStatusMsg::numReports, DtRtiMsg::setFederateHandle(), DtRtiMsg::setFedEx(), testCapable(), and DtNetTestMgrStatusMsg::testInProgress.

DtTestMgrStatusMsg::DtTestMgrStatusMsg	(	const DtNetTestMgrStatusMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetTestMgrStatusMsg::header, and DtRtiMsg::initDtRtiMsg().

DtTestMgrStatusMsg::~DtTestMgrStatusMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtTestMgrStatusMsg::addCallback	(	DtConnectionMgr *	conn,
		DtTestMgrStatusCb	cb,
		void *	usr
	)		[static]

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

References DtConnectionMgr::addMsgCallback(), and DtTestMgrStatusMsgKind.

DtRtiMsg * DtTestMgrStatusMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtTestMgrStatusMsg(), and netTestMgrStatusMsg().

bool DtTestMgrStatusMsg::continuousTesting

(

)

const [virtual]

Is the LRC's test manager currently running a continuous test?

References DtNetTestMgrStatusMsg::continuous, and netTestMgrStatusMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processLatencyTestStatusMsg().

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

Creators.

References DtTestMgrStatusMsg().

DtRtiMsg * DtTestMgrStatusMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtTestMgrStatusMsg().

DtRtiMsgKind DtTestMgrStatusMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of a DtTestMgrStatusMsg message.

Implements DtRtiMsg.

References DtTestMgrStatusMsgKind.

Referenced by DtTestMgrStatusMsg().

DtNetTestMgrStatusMsg * DtTestMgrStatusMsg::netTestMgrStatusMsg

(

)

[protected, virtual]

The network representation for the TestMgrStatusMsg message.

Referenced by clone(), continuousTesting(), DtTestMgrStatusMsg(), numTestReports(), numTestsInitiated(), testCapable(), testingEnabled(), and testInProgress().

const DtNetTestMgrStatusMsg * DtTestMgrStatusMsg::netTestMgrStatusMsg

(

)

const [protected, virtual]

unsigned DtTestMgrStatusMsg::numTestReports

(

)

const [virtual]

Number of test reports the federate has generated.

References netTestMgrStatusMsg(), and DtNetTestMgrStatusMsg::numReports.

Referenced by printData(), and DtRtiexecObserverForAssistant::processLatencyTestStatusMsg().

unsigned DtTestMgrStatusMsg::numTestsInitiated

(

)

const [virtual]

Number of tests the federate has initiated.

References netTestMgrStatusMsg(), and DtNetTestMgrStatusMsg::numInitiated.

Referenced by printData(), and DtRtiexecObserverForAssistant::processLatencyTestStatusMsg().

void DtTestMgrStatusMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References continuousTesting(), numTestReports(), numTestsInitiated(), testCapable(), testingEnabled(), and testInProgress().

void DtTestMgrStatusMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtTestMgrStatusCb	cb,
		void *	usr
	)		[static]

References DtTestMgrStatusMsgKind, and DtConnectionMgr::removeMsgCallback().

bool DtTestMgrStatusMsg::testCapable

(

)

const [virtual]

Is the LRC currently capable of running a test?

References DtNetTestMgrStatusMsg::capable, and netTestMgrStatusMsg().

Referenced by DtTestMgrStatusMsg(), printData(), and DtRtiexecObserverForAssistant::processLatencyTestStatusMsg().

bool DtTestMgrStatusMsg::testingEnabled

(

)

const [virtual]

Is the LRC's test manager enabled?

References DtNetTestMgrStatusMsg::enabled, and netTestMgrStatusMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processLatencyTestStatusMsg().

bool DtTestMgrStatusMsg::testInProgress

(

)

const [virtual]

Is the LRC currently running a test?

References netTestMgrStatusMsg(), and DtNetTestMgrStatusMsg::testInProgress.

Referenced by printData(), and DtRtiexecObserverForAssistant::processLatencyTestStatusMsg().

---

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

• testMgrStatusMsg.h
• testMgrStatusMsg.cxx