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:

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.
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 (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)
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 DtNetAssistantTestMgrStatusMsg *	netAssistantTestMgrStatusMsg ()
	The network representation for the AssistantTestMgrStatusMsg message.
virtual const DtNetAssistantTestMgrStatusMsg *	netAssistantTestMgrStatusMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantTestMgrStatusMsg message.
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 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`
	)

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 ( )

protectedvirtual

Returns the kind of a DtAssistantTestMgrStatusMsg message.

Implements DtAssistantMsg.

References DtAssistantTestMgrStatusMsgKind.

Referenced by DtAssistantTestMgrStatusMsg().

DtNetAssistantTestMgrStatusMsg * DtAssistantTestMgrStatusMsg::netAssistantTestMgrStatusMsg ( )

protectedvirtual

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

protectedvirtual

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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation