![]() |
MAK RTIspy API Documentation for HLA 1.3
|
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 |
DtAveragedLatencyTestReport encodes and decodes reports from tests between local RTI components.
| DtAveragedLatencyTestReport::DtAveragedLatencyTestReport | ( | ) |
| DtAveragedLatencyTestReport::~DtAveragedLatencyTestReport | ( | ) |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set / Get the best effort RTT of this test.
|
virtual |
Get / set the average initiator Best Effort tick time.
|
virtual |
Get / set the recipient average tick time.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set / Get the reliable RTT of this test.
|
virtual |
Decode our contents from data pointer.
|
staticprotected |
Return the would be size of the string including alignment padding.
|
virtual |
Encode our contents into the input data pointer.
|
virtual |
Set / Get the federation handle of this test.
| void DtAveragedLatencyTestReport::getProcessingModel | ( | DtRIDParameters::DtAsynchronousIOModeEnum & | initiator, |
| DtRIDParameters::DtAsynchronousIOModeEnum & | recip | ||
| ) | const |
get processingModel of initiator and recipient.
|
protectedvirtual |
Generic mutator of the 5 always present types.
|
staticprotected |
Read the type, time and advance what dataPtr points to.
|
virtual |
Set / Get the fed handle of the initiator of this test.
|
virtual |
Set / get the initiator federate name.
|
virtual |
Set / Get how many completed best effort interactions were averaged to get this result.
|
virtual |
Set / Get how many completed reliable interactions were averaged to get this result.
|
virtual |
Set / Get how many best effort interaction were dropped in generating this report.
|
virtual |
Set / Get how many reliable interaction were dropped in generating this report.
|
staticprotected |
|
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.
|
staticprotected |
|
virtual |
Set / Get The fed handle of the recipient of this test.
|
virtual |
Get /Set the recipient name.
|
static |
Does this model require an Asynchronous Msg Queue Stamp?
|
virtual |
Set / Get the average Best Effort Initiator Message In Queue Time.
|
virtual |
Set / Get the average Best Effort Initiator Receive Interaction time .
|
virtual |
Set / Get the average Best Effort Initiator Send Interaction time.
|
virtual |
Set / Get the average Best Effort Recipient Encode/Decode Interaction time.
|
virtual |
Set Get the average Best Effort Recipient Message In Queue Time.
|
virtual |
Set / Get the average Best Effort Recipient Receive Interaction time.
|
virtual |
Set / Get the average Best Effort Recipient Send Interaction time.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set / Get the average Reliable Initiator Message In Queue Time.
|
virtual |
Set / Get the average Reliable Initiator Receive Interaction time .
|
virtual |
Set / Get the average Reliable Initiator Send Interaction time.
|
virtual |
Set / Get the average Best Effort Recipient Encode/Decode Interaction time.
|
virtual |
Set Get the average Reliable Recipient Message In Queue Time.
|
virtual |
Set / Get the average Reliable Recipient Receive Interaction time.
|
virtual |
Set / Get the average Best Effort Recipient Send Interaction time.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set the initiator processing model.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set the recipient processing model.
|
protectedvirtual |
Generic accessor of the 5 always present types.
|
staticprotected |
Write the type, time and advance what dataPtr points to.
|
virtual |
Returns the size of the data encoded.
|
staticprotected |
|
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.
|
staticprotected |
|
protected |
If necessary the time between AsyncQueueMsg and receiveInteraction for the Initiator.
|
protected |
The Best Effort time between the netRead and the receiveInteraction call for the Initiator.
|
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
|
protected |
The Best Effort time between the recipient receiveInteraction and response sendInteraction call.
|
protected |
These are only necessary in DtAsynchronousMode and DtAsynchronousProcessMessage.
If necessary the time between Best Effort AsyncQueueMsg and receiveInteraction for the Recipient.
|
protected |
The Best Effort time between the netRead and the receiveInteraction call for the Recipient.
|
protected |
The Best Effort time between the sendInteraction call and the netSend for the Recipient.
|
protected |
The average tick time of the initiator.
|
protected |
The average tick time of the recipient.
|
protected |
If necessary the time between AsyncQueueMsg and receiveInteraction for the Initiator.
|
protected |
The Reliable time between the netRead and the receiveInteraction call for the Initiator.
|
protected |
The Reliable time between the sendInteraction call and the netSend for the Initiator.
|
protected |
The Reliable time between the recipient receiveInteraction and response sendInteraction call.
|
protected |
These are only necessary in DtAsynchronousMode and DtAsynchronousProcessMessage.
If necessary the time between Reliable AsyncQueueMsg and receiveInteraction for the Recipient.
|
protected |
The Reliable time between the netRead and the receiveInteraction call for the Recipient.
|
protected |
The Reliable time between the sendInteraction call and the netSend for the Recipient.
|
protected |
The calculated Best Effort latency.
|
protected |
The federation handle.
|
protected |
The federate handle of the initiator.
|
protected |
queue of pairs of forwarder times.
Name of the initiating federate.
|
protected |
|
protected |
The number of completed best effort interactions in this test.
|
protected |
The number of dropped Best Effort interactions in this test.
|
protected |
The number of dropped Reliable interactions in this test.
|
protected |
The number of completed reliable interactions in this test.
|
protected |
The federate handle of the recipient.
|
protected |
Name of the recipient federate.
|
protected |
The processing models of the recipient and initiator respectively.
|
protected |
The calculated Reliable latency.
|
staticprotected |