DtAveragedLatencyTestReport Class Reference

DtAveragedLatencyTestReport encodes and decodes reports from tests between local RTI components. More...

Collaboration diagram for DtAveragedLatencyTestReport:

Public Member Functions
	DtAveragedLatencyTestReport ()
	~DtAveragedLatencyTestReport ()
virtual void	decodeFromMsg (const unsigned char *data, unsigned int size)
	Decode our contents from data pointer.
virtual void	encodeToMsg (unsigned char *destPtr) const
	Encode our contents into the input data pointer.
virtual unsigned int	sizeRequiredToDecode () const
	Returns the size of the data encoded.
void	getProcessingModel (DtRIDParameters::DtAsynchronousIOModeEnum &initiator, DtRIDParameters::DtAsynchronousIOModeEnum &recip) const
	get processingModel of initiator and recipient.
virtual void	setInitiatorProcessingModel (DtRIDParameters::DtAsynchronousIOModeEnum initModel)
	Set the initiator processing model.
virtual void	setRecipientProcessingModel (DtRIDParameters::DtAsynchronousIOModeEnum recipModel)
	Set the recipient processing model.
virtual unsigned int	federationHandle () const
	Set / Get the federation handle of this test.
virtual void	setFederationHandle (unsigned int num)
virtual unsigned int	initiatorFedHandle () const
	Set / Get the fed handle of the initiator of this test.
virtual void	setInitiatorFedHandle (unsigned int num)
virtual unsigned int	recipientFedHandle () const
	Set / Get The fed handle of the recipient of this test.
virtual void	setRecipientFedHandle (unsigned int num)
virtual void	initiatorFedName (MAKRti::DtString &name) const
	Set / get the initiator federate name.
virtual void	setInitiatorFedName (const MAKRti::DtString &name)
virtual void	recipientFedName (MAKRti::DtString &name) const
	Get /Set the recipient name.
virtual void	setRecipientFedName (const MAKRti::DtString &name)
virtual unsigned int	numCompletedBestEffortInteractions () const
	Set / Get how many completed best effort interactions were averaged to get this result.
virtual void	setNumCompletedBestEffortInteractions (unsigned int num)
virtual unsigned int	numCompletedReliableInteractions () const
	Set / Get how many completed reliable interactions were averaged to get this result.
virtual void	setNumCompletedReliableInteractions (unsigned int num)
virtual unsigned int	numDroppedBestEffortInteractions () const
	Set / Get how many best effort interaction were dropped in generating this report.
virtual void	setNumDroppedBestEffortInteractions (unsigned int num)
virtual unsigned int	numDroppedReliableInteractions () const
	Set / Get how many reliable interaction were dropped in generating this report.
virtual void	setNumDroppedReliableInteractions (unsigned int num)
virtual unsigned int	averageInitiatorTickTimeUsecs () const
	Get / set the average initiator Best Effort tick time.
virtual void	setAverageInitiatorTickTimeUsecs (unsigned int time)
virtual unsigned int	averageRecipientTickTimeUsecs () const
	Get / set the recipient average tick time.
virtual void	setAverageRecipientTickTimeUsecs (unsigned int time)
virtual unsigned int	averageBestEffortRoundTripTime () const
	Set / Get the best effort RTT of this test.
virtual void	setAverageBestEffortRoundTripTime (unsigned int num)
virtual unsigned int	averageReliableRoundTripTime () const
	Set / Get the reliable RTT of this test.
virtual void	setAverageReliableRoundTripTime (unsigned int num)
virtual void	setAverageBestEffortInitiatorSendInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Initiator Send Interaction time.
virtual encodedTimeType	averageBestEffortInitiatorSendInteractionUSecs () const
virtual void	setAverageReliableInitiatorSendInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Reliable Initiator Send Interaction time.
virtual encodedTimeType	averageReliableInitiatorSendInteractionUSecs () const
virtual void	setAverageBestEffortRecipientMsgQueuedUsecs (encodedTimeType microSeconds)
	Set Get the average Best Effort Recipient Message In Queue Time.
virtual encodedTimeType	averageBestEffortRecipientMsgQueuedUsecs () const
virtual void	setAverageReliableRecipientMsgQueuedUsecs (encodedTimeType microSeconds)
	Set Get the average Reliable Recipient Message In Queue Time.
virtual encodedTimeType	averageReliableRecipientMsgQueuedUsecs () const
virtual void	setAverageBestEffortRecipientReceiveInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Recipient Receive Interaction time.
virtual encodedTimeType	averageBestEffortRecipientReceiveInteractionUSecs () const
virtual void	setAverageReliableRecipientReceiveInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Reliable Recipient Receive Interaction time.
virtual encodedTimeType	averageReliableRecipientReceiveInteractionUSecs () const
virtual void	setAverageBestEffortRecipientEncodeDecodeInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Recipient Encode/Decode Interaction time.
virtual encodedTimeType	averageBestEffortRecipientEncodeDecodeInteractionUSecs () const
virtual void	setAverageReliableRecipientEncodeDecodeInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Recipient Encode/Decode Interaction time.
virtual encodedTimeType	averageReliableRecipientEncodeDecodeInteractionUSecs () const
virtual void	setAverageBestEffortRecipientSendInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Recipient Send Interaction time.
virtual encodedTimeType	averageBestEffortRecipientSendInteractionUSecs () const
virtual void	setAverageReliableRecipientSendInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Recipient Send Interaction time.
virtual encodedTimeType	averageReliableRecipientSendInteractionUSecs () const
virtual void	setAverageBestEffortInitiatorMsgQueuedUsecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Initiator Message In Queue Time.
virtual encodedTimeType	averageBestEffortInitiatorMsgQueuedUsecs () const
virtual void	setAverageReliableInitiatorMsgQueuedUsecs (encodedTimeType microSeconds)
	Set / Get the average Reliable Initiator Message In Queue Time.
virtual encodedTimeType	averageReliableInitiatorMsgQueuedUsecs () const
virtual void	setAverageBestEffortInitiatorReceiveInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Best Effort Initiator Receive Interaction time .
virtual encodedTimeType	averageBestEffortInitiatorReceiveInteractionUSecs () const
virtual void	setAverageReliableInitiatorReceiveInteractionUSecs (encodedTimeType microSeconds)
	Set / Get the average Reliable Initiator Receive Interaction time .
virtual encodedTimeType	averageReliableInitiatorReceiveInteractionUSecs () const

Static Public Member Functions
static bool	requiresQueueMsgStamp (DtRIDParameters::DtAsynchronousIOModeEnum model)
	Does this model require an Asynchronous Msg Queue Stamp?

Protected Member Functions
virtual void	setSingleTimeByType (DtAssistantReportTimeStampType, encodedTimeType num)
	Generic accessor of the 5 always present types.
virtual encodedTimeType	getSingleTimeByType (DtAssistantReportTimeStampType) const
	Generic mutator of the 5 always present types.

Static Protected Member Functions
static void	setSingleTimeToPtr (DtAssistantReportTimeStampType type, encodedTimeType time, unsigned char **dataPtrPtr)
	Write the type, time and advance what dataPtr points to.
static void	getSingleTimeFromPtr (DtAssistantReportTimeStampType &type, encodedTimeType &time, const unsigned char **dataPtrPtr)
	Read the type, time and advance what dataPtr points to.
static void	writeUintAndAdvancePtr (unsigned int num, unsigned char **dataPtrPtr)
static void	readUintAndAdvancePtr (unsigned int &num, unsigned char **dataPtrPtr)
static void	writeFloatAndAdvancePtr (const float &num, unsigned char **dataPtrPtr)
static void	readFloatAndAdvancePtr (float &num, unsigned char **dataPtrPtr)
static void	writeSizeAndStringAndAdvancePtr (const MAKRti::DtString &name, unsigned char **dataPtrPtr)
	Write the size of the padded string and then the string to the dataPtr.
static void	readSizeAndStringAndAdvancePtr (MAKRti::DtString &name, unsigned char **dataPtrPtr, unsigned int &encodedSize)
	Read the size of the padded string and then the string from the dataPtr.
static unsigned int	determineSizeOfPaddedSting (const MAKRti::DtString &string)
	Return the would be size of the string including alignment padding.

Protected Attributes
encodedTimeType	myAverageBestEffortInitiatorSendInteractionTime
	The following averages are expressed in whole number of microseconds.
encodedTimeType	myAverageBestEffortRecipientReceiveInteractionTime
	The Best Effort time between the netRead and the receiveInteraction call for the Recipient.
encodedTimeType	myAverageBestEffortRecipientEncodeDecodeTime
	The Best Effort time between the recipient receiveInteraction and response sendInteraction call.
encodedTimeType	myAverageBestEffortRecipientSendInteractionTime
	The Best Effort time between the sendInteraction call and the netSend for the Recipient.
encodedTimeType	myAverageBestEffortInitiatorReceiveInteractionTime
	The Best Effort time between the netRead and the receiveInteraction call for the Initiator.
encodedTimeType	myAverageBestEffortRecipientQueueMsgTime
	These are only necessary in DtAsynchronousMode and DtAsynchronousProcessMessage.
encodedTimeType	myAverageBestEffortInitiatorQueueMsgTime
	If necessary the time between AsyncQueueMsg and receiveInteraction for the Initiator.
encodedTimeType	myAverageReliableInitiatorSendInteractionTime
	The Reliable time between the sendInteraction call and the netSend for the Initiator.
encodedTimeType	myAverageReliableRecipientReceiveInteractionTime
	The Reliable time between the netRead and the receiveInteraction call for the Recipient.
encodedTimeType	myAverageReliableRecipientEncodeDecodeTime
	The Reliable time between the recipient receiveInteraction and response sendInteraction call.
encodedTimeType	myAverageReliableRecipientSendInteractionTime
	The Reliable time between the sendInteraction call and the netSend for the Recipient.
encodedTimeType	myAverageReliableInitiatorReceiveInteractionTime
	The Reliable time between the netRead and the receiveInteraction call for the Initiator.
encodedTimeType	myAverageReliableRecipientQueueMsgTime
	These are only necessary in DtAsynchronousMode and DtAsynchronousProcessMessage.
encodedTimeType	myAverageReliableInitiatorQueueMsgTime
	If necessary the time between AsyncQueueMsg and receiveInteraction for the Initiator.
DtRIDParameters::DtAsynchronousIOModeEnum	myRecipModel
	The processing models of the recipient and initiator respectively.
DtRIDParameters::DtAsynchronousIOModeEnum	myInitModel
MAKRti::DtString	myInitiatorFederateName
	queue of pairs of forwarder times.
MAKRti::DtString	myRecipientFederateName
	Name of the recipient federate.
unsigned int	myFederation
	The federation handle.
unsigned int	myInitiatorFed
	The federate handle of the initiator.
unsigned int	myRecipientFed
	The federate handle of the recipient.
unsigned int	myNumBestEffortInteractions
	The number of completed best effort interactions in this test.
unsigned int	myNumReliableInteractions
	The number of completed reliable interactions in this test.
unsigned int	myNumDroppedBestEffort
	The number of dropped Best Effort interactions in this test.
unsigned int	myNumDroppedReliable
	The number of dropped Reliable interactions in this test.
unsigned int	myBestEffortRoundTripTime
	The calculated Best Effort latency.
unsigned int	myReliableRoundTripTime
	The calculated Reliable latency.
unsigned int	myAverageRecipientTickTime
	The average tick time of the recipient.
unsigned int	myAverageInitiatorTickTime
	The average tick time of the initiator.

Static Protected Attributes
static const encodedTimeType	theInvalidEncodedTime = -1

Detailed Description

DtAveragedLatencyTestReport encodes and decodes reports from tests between local RTI components.

Constructor & Destructor Documentation

DtAveragedLatencyTestReport::DtAveragedLatencyTestReport

(

)

DtAveragedLatencyTestReport::~DtAveragedLatencyTestReport

(

)

Member Function Documentation

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortInitiatorMsgQueuedUsecs ( ) const

virtual

References myAverageBestEffortInitiatorQueueMsgTime.

Referenced by encodeToMsg(), getSingleTimeByType(), and DtAssistantLatencyTestMgr::processLatencyTestResults().

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortInitiatorReceiveInteractionUSecs ( ) const

virtual

References myAverageBestEffortInitiatorReceiveInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortInitiatorSendInteractionUSecs ( ) const

virtual

References myAverageBestEffortInitiatorSendInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortRecipientEncodeDecodeInteractionUSecs ( ) const

virtual

References myAverageBestEffortRecipientEncodeDecodeTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortRecipientMsgQueuedUsecs ( ) const

virtual

References myAverageBestEffortRecipientQueueMsgTime.

Referenced by encodeToMsg(), getSingleTimeByType(), and DtAssistantLatencyTestMgr::processLatencyTestResults().

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortRecipientReceiveInteractionUSecs ( ) const

virtual

References myAverageBestEffortRecipientReceiveInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageBestEffortRecipientSendInteractionUSecs ( ) const

virtual

References myAverageBestEffortRecipientSendInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

unsigned int DtAveragedLatencyTestReport::averageBestEffortRoundTripTime ( ) const

virtual

Set / Get the best effort RTT of this test.

References myBestEffortRoundTripTime.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

unsigned int DtAveragedLatencyTestReport::averageInitiatorTickTimeUsecs ( ) const

virtual

Get / set the average initiator Best Effort tick time.

References myAverageInitiatorTickTime.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

unsigned int DtAveragedLatencyTestReport::averageRecipientTickTimeUsecs ( ) const

virtual

Get / set the recipient average tick time.

References myAverageRecipientTickTime.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

encodedTimeType DtAveragedLatencyTestReport::averageReliableInitiatorMsgQueuedUsecs ( ) const

virtual

References myAverageReliableInitiatorQueueMsgTime.

Referenced by encodeToMsg(), getSingleTimeByType(), and DtAssistantLatencyTestMgr::processLatencyTestResults().

encodedTimeType DtAveragedLatencyTestReport::averageReliableInitiatorReceiveInteractionUSecs ( ) const

virtual

References myAverageReliableInitiatorReceiveInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageReliableInitiatorSendInteractionUSecs ( ) const

virtual

References myAverageReliableInitiatorSendInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageReliableRecipientEncodeDecodeInteractionUSecs ( ) const

virtual

References myAverageReliableRecipientEncodeDecodeTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageReliableRecipientMsgQueuedUsecs ( ) const

virtual

References myAverageReliableRecipientQueueMsgTime.

Referenced by encodeToMsg(), getSingleTimeByType(), and DtAssistantLatencyTestMgr::processLatencyTestResults().

encodedTimeType DtAveragedLatencyTestReport::averageReliableRecipientReceiveInteractionUSecs ( ) const

virtual

References myAverageReliableRecipientReceiveInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

encodedTimeType DtAveragedLatencyTestReport::averageReliableRecipientSendInteractionUSecs ( ) const

virtual

References myAverageReliableRecipientSendInteractionTime.

Referenced by encodeToMsg(), and getSingleTimeByType().

unsigned int DtAveragedLatencyTestReport::averageReliableRoundTripTime ( ) const

virtual

Set / Get the reliable RTT of this test.

References myReliableRoundTripTime.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

void DtAveragedLatencyTestReport::decodeFromMsg ( const unsigned char *  data, unsigned int  size  )

virtual

Decode our contents from data pointer.

References getSingleTimeFromPtr(), myAverageInitiatorTickTime, myAverageRecipientTickTime, myBestEffortRoundTripTime, myFederation, myInitiatorFed, myInitiatorFederateName, myInitModel, myNumBestEffortInteractions, myNumDroppedBestEffort, myNumDroppedReliable, myNumReliableInteractions, myRecipientFed, myRecipientFederateName, myRecipModel, myReliableRoundTripTime, readSizeAndStringAndAdvancePtr(), readUintAndAdvancePtr(), and setSingleTimeByType().

Referenced by DtLatencyReportMsg::get(), and DtAssistantLatencyReportMsg::get().

unsigned int DtAveragedLatencyTestReport::determineSizeOfPaddedSting ( const MAKRti::DtString &  string )

staticprotected

Return the would be size of the string including alignment padding.

Referenced by sizeRequiredToDecode(), and writeSizeAndStringAndAdvancePtr().

void DtAveragedLatencyTestReport::encodeToMsg ( unsigned char *  destPtr ) const

virtual

Encode our contents into the input data pointer.

References averageBestEffortInitiatorMsgQueuedUsecs(), averageBestEffortInitiatorReceiveInteractionUSecs(), averageBestEffortInitiatorSendInteractionUSecs(), averageBestEffortRecipientEncodeDecodeInteractionUSecs(), averageBestEffortRecipientMsgQueuedUsecs(), averageBestEffortRecipientReceiveInteractionUSecs(), averageBestEffortRecipientSendInteractionUSecs(), averageReliableInitiatorMsgQueuedUsecs(), averageReliableInitiatorReceiveInteractionUSecs(), averageReliableInitiatorSendInteractionUSecs(), averageReliableRecipientEncodeDecodeInteractionUSecs(), averageReliableRecipientMsgQueuedUsecs(), averageReliableRecipientReceiveInteractionUSecs(), averageReliableRecipientSendInteractionUSecs(), DtAverageBestEffortInitiatorQueueMsgTime, DtAverageBestEffortInitiatorReceiveInteractionTime, DtAverageBestEffortInitiatorSendInteractionTime, DtAverageBestEffortRecipientEncodeDecodeTime, DtAverageBestEffortRecipientQueueMsgTime, DtAverageBestEffortRecipientReceiveInteractionTime, DtAverageBestEffortRecipientSendInteractionTime, DtAverageReliableInitiatorQueueMsgTime, DtAverageReliableInitiatorReceiveInteractionTime, DtAverageReliableInitiatorSendInteractionTime, DtAverageReliableRecipientEncodeDecodeTime, DtAverageReliableRecipientQueueMsgTime, DtAverageReliableRecipientReceiveInteractionTime, DtAverageReliableRecipientSendInteractionTime, myAverageInitiatorTickTime, myAverageRecipientTickTime, myBestEffortRoundTripTime, myFederation, myInitiatorFed, myInitiatorFederateName, myInitModel, myNumBestEffortInteractions, myNumDroppedBestEffort, myNumDroppedReliable, myNumReliableInteractions, myRecipientFed, myRecipientFederateName, myRecipModel, myReliableRoundTripTime, requiresQueueMsgStamp(), setSingleTimeToPtr(), writeSizeAndStringAndAdvancePtr(), and writeUintAndAdvancePtr().

Referenced by DtLatencyReportMsg::set(), and DtAssistantLatencyReportMsg::set().

unsigned int DtAveragedLatencyTestReport::federationHandle ( ) const

virtual

Set / Get the federation handle of this test.

References myFederation.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

void DtAveragedLatencyTestReport::getProcessingModel	(	DtRIDParameters::DtAsynchronousIOModeEnum &	initiator,
		DtRIDParameters::DtAsynchronousIOModeEnum &	recip
	)		const

get processingModel of initiator and recipient.

References myInitModel, and myRecipModel.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

encodedTimeType DtAveragedLatencyTestReport::getSingleTimeByType ( DtAssistantReportTimeStampType  type ) const

protectedvirtual

Generic mutator of the 5 always present types.

References averageBestEffortInitiatorMsgQueuedUsecs(), averageBestEffortInitiatorReceiveInteractionUSecs(), averageBestEffortInitiatorSendInteractionUSecs(), averageBestEffortRecipientEncodeDecodeInteractionUSecs(), averageBestEffortRecipientMsgQueuedUsecs(), averageBestEffortRecipientReceiveInteractionUSecs(), averageBestEffortRecipientSendInteractionUSecs(), averageReliableInitiatorMsgQueuedUsecs(), averageReliableInitiatorReceiveInteractionUSecs(), averageReliableInitiatorSendInteractionUSecs(), averageReliableRecipientEncodeDecodeInteractionUSecs(), averageReliableRecipientMsgQueuedUsecs(), averageReliableRecipientReceiveInteractionUSecs(), averageReliableRecipientSendInteractionUSecs(), DtAverageBestEffortInitiatorQueueMsgTime, DtAverageBestEffortInitiatorReceiveInteractionTime, DtAverageBestEffortInitiatorSendInteractionTime, DtAverageBestEffortRecipientEncodeDecodeTime, DtAverageBestEffortRecipientQueueMsgTime, DtAverageBestEffortRecipientReceiveInteractionTime, DtAverageBestEffortRecipientSendInteractionTime, DtAverageReliableInitiatorQueueMsgTime, DtAverageReliableInitiatorReceiveInteractionTime, DtAverageReliableInitiatorSendInteractionTime, DtAverageReliableRecipientEncodeDecodeTime, DtAverageReliableRecipientQueueMsgTime, DtAverageReliableRecipientReceiveInteractionTime, DtAverageReliableRecipientSendInteractionTime, DtPaddingType, and theInvalidEncodedTime.

void DtAveragedLatencyTestReport::getSingleTimeFromPtr ( DtAssistantReportTimeStampType &  type, encodedTimeType &  time, const unsigned char **  dataPtrPtr  )

staticprotected

Read the type, time and advance what dataPtr points to.

Referenced by decodeFromMsg().

unsigned int DtAveragedLatencyTestReport::initiatorFedHandle ( ) const

virtual

Set / Get the fed handle of the initiator of this test.

References myInitiatorFed.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

void DtAveragedLatencyTestReport::initiatorFedName ( MAKRti::DtString &  name ) const

virtual

Set / get the initiator federate name.

References myInitiatorFederateName.

unsigned int DtAveragedLatencyTestReport::numCompletedBestEffortInteractions ( ) const

virtual

Set / Get how many completed best effort interactions were averaged to get this result.

References myNumBestEffortInteractions.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

unsigned int DtAveragedLatencyTestReport::numCompletedReliableInteractions ( ) const

virtual

Set / Get how many completed reliable interactions were averaged to get this result.

References myNumReliableInteractions.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

unsigned int DtAveragedLatencyTestReport::numDroppedBestEffortInteractions ( ) const

virtual

Set / Get how many best effort interaction were dropped in generating this report.

References myNumDroppedBestEffort.

unsigned int DtAveragedLatencyTestReport::numDroppedReliableInteractions ( ) const

virtual

Set / Get how many reliable interaction were dropped in generating this report.

References myNumDroppedReliable.

void DtAveragedLatencyTestReport::readFloatAndAdvancePtr ( float &  num, unsigned char **  dataPtrPtr  )

staticprotected

void DtAveragedLatencyTestReport::readSizeAndStringAndAdvancePtr ( MAKRti::DtString &  name, unsigned char **  dataPtrPtr, unsigned int &  encodedSize  )

staticprotected

Read the size of the padded string and then the string from the dataPtr.

The string has to be padded to preserve 32 bit alignment. Return the size of the written string.

Referenced by decodeFromMsg().

void DtAveragedLatencyTestReport::readUintAndAdvancePtr ( unsigned int &  num, unsigned char **  dataPtrPtr  )

staticprotected

Referenced by decodeFromMsg().

unsigned int DtAveragedLatencyTestReport::recipientFedHandle ( ) const

virtual

Set / Get The fed handle of the recipient of this test.

References myRecipientFed.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

void DtAveragedLatencyTestReport::recipientFedName ( MAKRti::DtString &  name ) const

virtual

Get /Set the recipient name.

References myRecipientFederateName.

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

bool DtAveragedLatencyTestReport::requiresQueueMsgStamp ( DtRIDParameters::DtAsynchronousIOModeEnum  model )

static

Does this model require an Asynchronous Msg Queue Stamp?

References DtRIDParameters::DtAsynchronousMode, and DtRIDParameters::DtAsynchronousProcessMessage.

Referenced by DtInitiatorLatencyTest::averageReports(), encodeToMsg(), and sizeRequiredToDecode().

void DtAveragedLatencyTestReport::setAverageBestEffortInitiatorMsgQueuedUsecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Initiator Message In Queue Time.

References myAverageBestEffortInitiatorQueueMsgTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortInitiatorReceiveInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Initiator Receive Interaction time .

References myAverageBestEffortInitiatorReceiveInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortInitiatorSendInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Initiator Send Interaction time.

References myAverageBestEffortInitiatorSendInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortRecipientEncodeDecodeInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Recipient Encode/Decode Interaction time.

References myAverageBestEffortRecipientEncodeDecodeTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortRecipientMsgQueuedUsecs ( encodedTimeType  microSeconds )

virtual

Set Get the average Best Effort Recipient Message In Queue Time.

References myAverageBestEffortRecipientQueueMsgTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortRecipientReceiveInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Recipient Receive Interaction time.

References myAverageBestEffortRecipientReceiveInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortRecipientSendInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Recipient Send Interaction time.

References myAverageBestEffortRecipientSendInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageBestEffortRoundTripTime ( unsigned int  num )

virtual

References myBestEffortRoundTripTime.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setAverageInitiatorTickTimeUsecs ( unsigned int  time )

virtual

References myAverageInitiatorTickTime.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setAverageRecipientTickTimeUsecs ( unsigned int  time )

virtual

References myAverageRecipientTickTime.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setAverageReliableInitiatorMsgQueuedUsecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Reliable Initiator Message In Queue Time.

References myAverageReliableInitiatorQueueMsgTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableInitiatorReceiveInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Reliable Initiator Receive Interaction time .

References myAverageReliableInitiatorReceiveInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableInitiatorSendInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Reliable Initiator Send Interaction time.

References myAverageReliableInitiatorSendInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableRecipientEncodeDecodeInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Recipient Encode/Decode Interaction time.

References myAverageReliableRecipientEncodeDecodeTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableRecipientMsgQueuedUsecs ( encodedTimeType  microSeconds )

virtual

Set Get the average Reliable Recipient Message In Queue Time.

References myAverageReliableRecipientQueueMsgTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableRecipientReceiveInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Reliable Recipient Receive Interaction time.

References myAverageReliableRecipientReceiveInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableRecipientSendInteractionUSecs ( encodedTimeType  microSeconds )

virtual

Set / Get the average Best Effort Recipient Send Interaction time.

References myAverageReliableRecipientSendInteractionTime.

Referenced by DtInitiatorLatencyTest::averageReports(), and setSingleTimeByType().

void DtAveragedLatencyTestReport::setAverageReliableRoundTripTime ( unsigned int  num )

virtual

References myReliableRoundTripTime.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setFederationHandle ( unsigned int  num )

virtual

References myFederation.

Referenced by DtInitiatorLatencyTest::averageReports(), and DtRtiexecObserverForAssistant::processLatencyTestResultsMsg().

void DtAveragedLatencyTestReport::setInitiatorFedHandle ( unsigned int  num )

virtual

References myInitiatorFed.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setInitiatorFedName ( const MAKRti::DtString &  name )

virtual

References myInitiatorFederateName.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setInitiatorProcessingModel ( DtRIDParameters::DtAsynchronousIOModeEnum  initModel )

virtual

Set the initiator processing model.

References myInitModel.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setNumCompletedBestEffortInteractions ( unsigned int  num )

virtual

References myNumBestEffortInteractions.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setNumCompletedReliableInteractions ( unsigned int  num )

virtual

References myNumReliableInteractions.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setNumDroppedBestEffortInteractions ( unsigned int  num )

virtual

References myNumDroppedBestEffort.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setNumDroppedReliableInteractions ( unsigned int  num )

virtual

References myNumDroppedReliable.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setRecipientFedHandle ( unsigned int  num )

virtual

References myRecipientFed.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setRecipientFedName ( const MAKRti::DtString &  name )

virtual

References myRecipientFederateName.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setRecipientProcessingModel ( DtRIDParameters::DtAsynchronousIOModeEnum  recipModel )

virtual

Set the recipient processing model.

References myRecipModel.

Referenced by DtInitiatorLatencyTest::averageReports().

void DtAveragedLatencyTestReport::setSingleTimeByType ( DtAssistantReportTimeStampType  type, encodedTimeType  num  )

protectedvirtual

Generic accessor of the 5 always present types.

References DtAverageBestEffortInitiatorQueueMsgTime, DtAverageBestEffortInitiatorReceiveInteractionTime, DtAverageBestEffortInitiatorSendInteractionTime, DtAverageBestEffortRecipientEncodeDecodeTime, DtAverageBestEffortRecipientQueueMsgTime, DtAverageBestEffortRecipientReceiveInteractionTime, DtAverageBestEffortRecipientSendInteractionTime, DtAverageReliableInitiatorQueueMsgTime, DtAverageReliableInitiatorReceiveInteractionTime, DtAverageReliableInitiatorSendInteractionTime, DtAverageReliableRecipientEncodeDecodeTime, DtAverageReliableRecipientQueueMsgTime, DtAverageReliableRecipientReceiveInteractionTime, DtAverageReliableRecipientSendInteractionTime, DtPaddingType, setAverageBestEffortInitiatorMsgQueuedUsecs(), setAverageBestEffortInitiatorReceiveInteractionUSecs(), setAverageBestEffortInitiatorSendInteractionUSecs(), setAverageBestEffortRecipientEncodeDecodeInteractionUSecs(), setAverageBestEffortRecipientMsgQueuedUsecs(), setAverageBestEffortRecipientReceiveInteractionUSecs(), setAverageBestEffortRecipientSendInteractionUSecs(), setAverageReliableInitiatorMsgQueuedUsecs(), setAverageReliableInitiatorReceiveInteractionUSecs(), setAverageReliableInitiatorSendInteractionUSecs(), setAverageReliableRecipientEncodeDecodeInteractionUSecs(), setAverageReliableRecipientMsgQueuedUsecs(), setAverageReliableRecipientReceiveInteractionUSecs(), and setAverageReliableRecipientSendInteractionUSecs().

Referenced by decodeFromMsg().

void DtAveragedLatencyTestReport::setSingleTimeToPtr ( DtAssistantReportTimeStampType  type, encodedTimeType  time, unsigned char **  dataPtrPtr  )

staticprotected

Write the type, time and advance what dataPtr points to.

Referenced by encodeToMsg().

unsigned int DtAveragedLatencyTestReport::sizeRequiredToDecode ( ) const

virtual

Returns the size of the data encoded.

References determineSizeOfPaddedSting(), myInitiatorFederateName, myInitModel, myRecipientFederateName, myRecipModel, and requiresQueueMsgStamp().

Referenced by DtLatencyReportMsg::set(), and DtAssistantLatencyReportMsg::set().

void DtAveragedLatencyTestReport::writeFloatAndAdvancePtr ( const float &  num, unsigned char **  dataPtrPtr  )

staticprotected

void DtAveragedLatencyTestReport::writeSizeAndStringAndAdvancePtr ( const MAKRti::DtString &  name, unsigned char **  dataPtrPtr  )

staticprotected

Write the size of the padded string and then the string to the dataPtr.

The string has to be padded to preserve 32 bit alignment.

References determineSizeOfPaddedSting().

Referenced by encodeToMsg().

void DtAveragedLatencyTestReport::writeUintAndAdvancePtr ( unsigned int  num, unsigned char **  dataPtrPtr  )

staticprotected

Referenced by encodeToMsg().

Member Data Documentation

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortInitiatorQueueMsgTime

protected

If necessary the time between AsyncQueueMsg and receiveInteraction for the Initiator.

Referenced by averageBestEffortInitiatorMsgQueuedUsecs(), and setAverageBestEffortInitiatorMsgQueuedUsecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortInitiatorReceiveInteractionTime

protected

The Best Effort time between the netRead and the receiveInteraction call for the Initiator.

Referenced by averageBestEffortInitiatorReceiveInteractionUSecs(), and setAverageBestEffortInitiatorReceiveInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortInitiatorSendInteractionTime

protected

The following averages are expressed in whole number of microseconds.

The Best Effort time between the sendInteraction call and the netSend for the Initiator

Referenced by averageBestEffortInitiatorSendInteractionUSecs(), and setAverageBestEffortInitiatorSendInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortRecipientEncodeDecodeTime

protected

The Best Effort time between the recipient receiveInteraction and response sendInteraction call.

Referenced by averageBestEffortRecipientEncodeDecodeInteractionUSecs(), and setAverageBestEffortRecipientEncodeDecodeInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortRecipientQueueMsgTime

protected

These are only necessary in DtAsynchronousMode and DtAsynchronousProcessMessage.

If necessary the time between Best Effort AsyncQueueMsg and receiveInteraction for the Recipient.

Referenced by averageBestEffortRecipientMsgQueuedUsecs(), and setAverageBestEffortRecipientMsgQueuedUsecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortRecipientReceiveInteractionTime

protected

The Best Effort time between the netRead and the receiveInteraction call for the Recipient.

Referenced by averageBestEffortRecipientReceiveInteractionUSecs(), and setAverageBestEffortRecipientReceiveInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageBestEffortRecipientSendInteractionTime

protected

The Best Effort time between the sendInteraction call and the netSend for the Recipient.

Referenced by averageBestEffortRecipientSendInteractionUSecs(), and setAverageBestEffortRecipientSendInteractionUSecs().

unsigned int DtAveragedLatencyTestReport::myAverageInitiatorTickTime

protected

The average tick time of the initiator.

Referenced by averageInitiatorTickTimeUsecs(), decodeFromMsg(), encodeToMsg(), and setAverageInitiatorTickTimeUsecs().

unsigned int DtAveragedLatencyTestReport::myAverageRecipientTickTime

protected

The average tick time of the recipient.

Referenced by averageRecipientTickTimeUsecs(), decodeFromMsg(), encodeToMsg(), and setAverageRecipientTickTimeUsecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableInitiatorQueueMsgTime

protected

If necessary the time between AsyncQueueMsg and receiveInteraction for the Initiator.

Referenced by averageReliableInitiatorMsgQueuedUsecs(), and setAverageReliableInitiatorMsgQueuedUsecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableInitiatorReceiveInteractionTime

protected

The Reliable time between the netRead and the receiveInteraction call for the Initiator.

Referenced by averageReliableInitiatorReceiveInteractionUSecs(), and setAverageReliableInitiatorReceiveInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableInitiatorSendInteractionTime

protected

The Reliable time between the sendInteraction call and the netSend for the Initiator.

Referenced by averageReliableInitiatorSendInteractionUSecs(), and setAverageReliableInitiatorSendInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableRecipientEncodeDecodeTime

protected

The Reliable time between the recipient receiveInteraction and response sendInteraction call.

Referenced by averageReliableRecipientEncodeDecodeInteractionUSecs(), and setAverageReliableRecipientEncodeDecodeInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableRecipientQueueMsgTime

protected

These are only necessary in DtAsynchronousMode and DtAsynchronousProcessMessage.

If necessary the time between Reliable AsyncQueueMsg and receiveInteraction for the Recipient.

Referenced by averageReliableRecipientMsgQueuedUsecs(), and setAverageReliableRecipientMsgQueuedUsecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableRecipientReceiveInteractionTime

protected

The Reliable time between the netRead and the receiveInteraction call for the Recipient.

Referenced by averageReliableRecipientReceiveInteractionUSecs(), and setAverageReliableRecipientReceiveInteractionUSecs().

encodedTimeType DtAveragedLatencyTestReport::myAverageReliableRecipientSendInteractionTime

protected

The Reliable time between the sendInteraction call and the netSend for the Recipient.

Referenced by averageReliableRecipientSendInteractionUSecs(), and setAverageReliableRecipientSendInteractionUSecs().

unsigned int DtAveragedLatencyTestReport::myBestEffortRoundTripTime

protected

The calculated Best Effort latency.

Referenced by averageBestEffortRoundTripTime(), decodeFromMsg(), encodeToMsg(), and setAverageBestEffortRoundTripTime().

unsigned int DtAveragedLatencyTestReport::myFederation

protected

The federation handle.

Referenced by decodeFromMsg(), encodeToMsg(), federationHandle(), and setFederationHandle().

unsigned int DtAveragedLatencyTestReport::myInitiatorFed

protected

The federate handle of the initiator.

Referenced by decodeFromMsg(), encodeToMsg(), initiatorFedHandle(), and setInitiatorFedHandle().

MAKRti::DtString DtAveragedLatencyTestReport::myInitiatorFederateName

protected

queue of pairs of forwarder times.

Name of the initiating federate.

Referenced by decodeFromMsg(), encodeToMsg(), initiatorFedName(), setInitiatorFedName(), and sizeRequiredToDecode().

DtRIDParameters::DtAsynchronousIOModeEnum DtAveragedLatencyTestReport::myInitModel

protected

Referenced by decodeFromMsg(), encodeToMsg(), getProcessingModel(), setInitiatorProcessingModel(), and sizeRequiredToDecode().

unsigned int DtAveragedLatencyTestReport::myNumBestEffortInteractions

protected

The number of completed best effort interactions in this test.

Referenced by decodeFromMsg(), encodeToMsg(), numCompletedBestEffortInteractions(), and setNumCompletedBestEffortInteractions().

unsigned int DtAveragedLatencyTestReport::myNumDroppedBestEffort

protected

The number of dropped Best Effort interactions in this test.

Referenced by decodeFromMsg(), encodeToMsg(), numDroppedBestEffortInteractions(), and setNumDroppedBestEffortInteractions().

unsigned int DtAveragedLatencyTestReport::myNumDroppedReliable

protected

The number of dropped Reliable interactions in this test.

Referenced by decodeFromMsg(), encodeToMsg(), numDroppedReliableInteractions(), and setNumDroppedReliableInteractions().

unsigned int DtAveragedLatencyTestReport::myNumReliableInteractions

protected

The number of completed reliable interactions in this test.

Referenced by decodeFromMsg(), encodeToMsg(), numCompletedReliableInteractions(), and setNumCompletedReliableInteractions().

unsigned int DtAveragedLatencyTestReport::myRecipientFed

protected

The federate handle of the recipient.

Referenced by decodeFromMsg(), encodeToMsg(), recipientFedHandle(), and setRecipientFedHandle().

MAKRti::DtString DtAveragedLatencyTestReport::myRecipientFederateName

protected

Name of the recipient federate.

Referenced by decodeFromMsg(), encodeToMsg(), recipientFedName(), setRecipientFedName(), and sizeRequiredToDecode().

DtRIDParameters::DtAsynchronousIOModeEnum DtAveragedLatencyTestReport::myRecipModel

protected

The processing models of the recipient and initiator respectively.

Referenced by decodeFromMsg(), encodeToMsg(), getProcessingModel(), setRecipientProcessingModel(), and sizeRequiredToDecode().

unsigned int DtAveragedLatencyTestReport::myReliableRoundTripTime

protected

The calculated Reliable latency.

Referenced by averageReliableRoundTripTime(), decodeFromMsg(), encodeToMsg(), and setAverageReliableRoundTripTime().

const encodedTimeType DtAveragedLatencyTestReport::theInvalidEncodedTime = -1

staticprotected

Referenced by getSingleTimeByType().

---

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

• averagedLatencyTestReport.h
• averagedLatencyTestReport.cxx