DtAssistantTestMgrStatusMsg Class Reference

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

Inheritance diagram for DtAssistantTestMgrStatusMsg:

Collaboration diagram for DtAssistantTestMgrStatusMsg:

List of all members.

Public Member Functions
	DtAssistantTestMgrStatusMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantTestMgrStatusMsg (bool testingEnabled, bool testCapable, bool isContinuous, bool inProgress, int numInitiated=0, int numReports=0, unsigned long federationHdl=0, unsigned long federateHdl=0, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantTestMgrStatusMsg (const DtNetAssistantTestMgrStatusMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantTestMgrStatusMsg ()
	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	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.
virtual unsigned long	federationHdl () const
	The handle of the federation that this message is concerning.
virtual unsigned long	federateHdl () const
	The handle of the federate that this message is concerning.
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, DtAssistantTestMgrStatusCb cb, void *usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer *conn, DtAssistantTestMgrStatusCb cb, void *usr)
static void	addCallback (DtRtiAssistantPeer *conn, DtAssistantTestMgrStatusCb cb, void *usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer *conn, DtAssistantTestMgrStatusCb cb, void *usr)
Protected Member Functions
virtual DtNetAssistantTestMgrStatusMsg *	netAssistantTestMgrStatusMsg ()
	The network representation for the AssistantTestMgrStatusMsg message.
virtual const DtNetAssistantTestMgrStatusMsg *	netAssistantTestMgrStatusMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantTestMgrStatusMsg message.

---

Detailed Description

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

---

Constructor & Destructor Documentation

DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

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

Referenced by clone(), and create().

DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg	(	bool	testingEnabled,
		bool	testCapable,
		bool	isContinuous,
		bool	inProgress,
		int	numInitiated = 0,
		int	numReports = 0,
		unsigned long	federationHdl = 0,
		unsigned long	federateHdl = 0,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetAssistantTestMgrStatusMsg::capable, DtNetAssistantTestMgrStatusMsg::continuous, DtNetAssistantTestMgrStatusMsg::enabled, DtNetAssistantTestMgrStatusMsg::federateHdl, federateHdl(), DtNetAssistantTestMgrStatusMsg::federationHdl, federationHdl(), DtAssistantMsg::initAssistantMsg(), internalMsgKind(), netAssistantTestMgrStatusMsg(), DtNetAssistantTestMgrStatusMsg::numInitiated, DtNetAssistantTestMgrStatusMsg::numReports, testCapable(), and DtNetAssistantTestMgrStatusMsg::testInProgress.

DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg	(	const DtNetAssistantTestMgrStatusMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetAssistantTestMgrStatusMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantTestMgrStatusMsg::~DtAssistantTestMgrStatusMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtAssistantTestMgrStatusMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantTestMgrStatusCb	cb,
		void *	usr
	)		[static]

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantTestMgrStatusMsgKind.

Referenced by DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr().

void DtAssistantTestMgrStatusMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantTestMgrStatusCb	cb,
		void *	usr
	)		[static]

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantTestMgrStatusMsgKind.

DtAssistantMsg * DtAssistantTestMgrStatusMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantTestMgrStatusMsg(), and netAssistantTestMgrStatusMsg().

bool DtAssistantTestMgrStatusMsg::continuousTesting

(

)

const [virtual]

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

References DtNetAssistantTestMgrStatusMsg::continuous, and netAssistantTestMgrStatusMsg().

Referenced by printData(), and DtAssistantLatencyTestMgr::processTestMgrStatusUpdate().

DtAssistantMsg * DtAssistantTestMgrStatusMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Creators.

References DtAssistantTestMgrStatusMsg().

DtAssistantMsg * DtAssistantTestMgrStatusMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtAssistantTestMgrStatusMsg().

unsigned long DtAssistantTestMgrStatusMsg::federateHdl

(

)

const [virtual]

The handle of the federate that this message is concerning.

This field is only used if the message is from an rtiexec.

References DtNetAssistantTestMgrStatusMsg::federateHdl, and netAssistantTestMgrStatusMsg().

Referenced by DtAssistantTestMgrStatusMsg(), and printData().

unsigned long DtAssistantTestMgrStatusMsg::federationHdl

(

)

const [virtual]

The handle of the federation that this message is concerning.

This field is only used if the message is from an rtiexec.

References DtNetAssistantTestMgrStatusMsg::federationHdl, and netAssistantTestMgrStatusMsg().

Referenced by DtAssistantTestMgrStatusMsg(), and printData().

DtAssistantMsgKind DtAssistantTestMgrStatusMsg::internalMsgKind

(

)

[protected, virtual]

Returns the kind of a DtAssistantTestMgrStatusMsg message.

Implements DtAssistantMsg.

References DtAssistantTestMgrStatusMsgKind.

Referenced by DtAssistantTestMgrStatusMsg().

DtNetAssistantTestMgrStatusMsg * DtAssistantTestMgrStatusMsg::netAssistantTestMgrStatusMsg

(

)

[protected, virtual]

The network representation for the AssistantTestMgrStatusMsg message.

Referenced by clone(), continuousTesting(), DtAssistantTestMgrStatusMsg(), federateHdl(), federationHdl(), numTestReports(), numTestsInitiated(), testCapable(), testingEnabled(), and testInProgress().

const DtNetAssistantTestMgrStatusMsg * DtAssistantTestMgrStatusMsg::netAssistantTestMgrStatusMsg

(

)

const [protected, virtual]

unsigned DtAssistantTestMgrStatusMsg::numTestReports

(

)

const [virtual]

Number of test reports the federate has generated.

References netAssistantTestMgrStatusMsg(), and DtNetAssistantTestMgrStatusMsg::numReports.

Referenced by printData().

unsigned DtAssistantTestMgrStatusMsg::numTestsInitiated

(

)

const [virtual]

Number of tests the federate has initiated.

References netAssistantTestMgrStatusMsg(), and DtNetAssistantTestMgrStatusMsg::numInitiated.

Referenced by printData().

void DtAssistantTestMgrStatusMsg::printData

(

)

const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

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

void DtAssistantTestMgrStatusMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantTestMgrStatusCb	cb,
		void *	usr
	)		[static]

References DtAssistantTestMgrStatusMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantLatencyTestMgr::~DtAssistantLatencyTestMgr().

void DtAssistantTestMgrStatusMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantTestMgrStatusCb	cb,
		void *	usr
	)		[static]

References DtAssistantTestMgrStatusMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

bool DtAssistantTestMgrStatusMsg::testCapable

(

)

const [virtual]

Is the LRC currently capable of running a test?

References DtNetAssistantTestMgrStatusMsg::capable, and netAssistantTestMgrStatusMsg().

Referenced by DtAssistantTestMgrStatusMsg(), printData(), and DtAssistantLatencyTestMgr::processTestMgrStatusUpdate().

bool DtAssistantTestMgrStatusMsg::testingEnabled

(

)

const [virtual]

Is the LRC's test manager enabled?

References DtNetAssistantTestMgrStatusMsg::enabled, and netAssistantTestMgrStatusMsg().

Referenced by printData(), and DtAssistantLatencyTestMgr::processTestMgrStatusUpdate().

bool DtAssistantTestMgrStatusMsg::testInProgress

(

)

const [virtual]

Is the LRC currently running a test?

References netAssistantTestMgrStatusMsg(), and DtNetAssistantTestMgrStatusMsg::testInProgress.

Referenced by printData(), and DtAssistantLatencyTestMgr::processTestMgrStatusUpdate().

---

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

• assistantTestMgrStatusMsg.h
• assistantTestMgrStatusMsg.cxx