MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Private Member Functions
DtRecipientLatencyTest Class Reference

DtRecipientLatencyTest runs network connectivity tests between local RTI components. More...

+ Inheritance diagram for DtRecipientLatencyTest:
+ Collaboration diagram for DtRecipientLatencyTest:

Public Member Functions

 DtRecipientLatencyTest (DtTestManager *parent)
 Constructor.
 DtRecipientLatencyTest ()
 Constructor.
virtual ~DtRecipientLatencyTest ()
 Destructor.
virtual bool tick ()
 Process test activities.
virtual void addSendInteractionTimeStamp (unsigned int testID)
 Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a send Interaction time stamp.
virtual void addNetSendTimeStamp (unsigned int testID, DtRtiMsg &msg)
 Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a net send time stamp.
virtual void addNetReceiveTimeStamp (unsigned int testID, const DtRtiMsg &msg)
 Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a net receive time stamp.
virtual void addReceiveInteractionTimeStamp (unsigned int testID, MAKRti::DtTime timeToUse)
 Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a receive interaction time stamp.
virtual void addAsyncQueueMsgTimeStamp (unsigned int testID, const DtRtiMsg &msg)
 Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a async Queue Msg time stamp.
- Public Member Functions inherited from DtLatencyTest
 DtLatencyTest (DtTestManager *parent)
 Constructor.
 DtLatencyTest ()
 Default constructor. Not implemented.
virtual ~DtLatencyTest ()
 Destructor.
virtual void postJoinInit ()
 Perform initializations that will allow tests to be run (e.g., publish and subscribe to test interaction)
virtual void resign ()
 Perform clean up from test instrumentation.
virtual void addTransportTypeForTestID (unsigned int testID, MAKRti::DtTransportType type)
 Add a mapping for this testID to this transport type.
virtual MAKRti::DtTransportType transportTypeForTestID (unsigned int testID) const
 look up the transport type for this testID.
virtual void removeKnowledgeOfTestId (unsigned int testID)
 Remove knowledge of this testID.
MAKRti::DtTime time () const

Private Member Functions

 DtRecipientLatencyTest (DtRecipientLatencyTest const &orig)
 Copy Constructor - not allowed.
DtRecipientLatencyTestoperator= (DtRecipientLatencyTest const &orig)
 Assignment operator - not allowed.

Additional Inherited Members

- Protected Types inherited from DtLatencyTest
typedef std::multimap
< DtMetadataType,
MAKRti::DtTime > 
DtTimeStampMap
typedef std::map< unsigned int,
DtTimeStampMap
DtTestToTimeStampMap
typedef std::multimap
< DtFederateHandle, unsigned
int > 
DtFedHandleToTestMap
- Protected Attributes inherited from DtLatencyTest
DtTestManagermyTestManager
DtTestToTimeStampMap myTestsInProgressTimeStamps
 TimeStamp storage (by testID) of all my known tests.
std::map< unsigned int,
MAKRti::DtTransportType > 
myTransportByTestID

Detailed Description

DtRecipientLatencyTest runs network connectivity tests between local RTI components.

Constructor & Destructor Documentation

DtRecipientLatencyTest::DtRecipientLatencyTest ( DtTestManager parent)

Constructor.

DtRecipientLatencyTest::DtRecipientLatencyTest ( )

Constructor.

DtRecipientLatencyTest::~DtRecipientLatencyTest ( )
virtual

Destructor.

DtRecipientLatencyTest::DtRecipientLatencyTest ( DtRecipientLatencyTest const &  orig)
private

Copy Constructor - not allowed.

Member Function Documentation

void DtRecipientLatencyTest::addAsyncQueueMsgTimeStamp ( unsigned int  testID,
const DtRtiMsg msg 
)
virtual

Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a async Queue Msg time stamp.

Implements DtLatencyTest.

References DtMetadataTypeTimeStampRecipientAsynchronousQueue, DtMetadataTypeTimeStampRecipientNetRead, DtRtiMtdTimeStamp::get(), DtLatencyTest::myTestsInProgressTimeStamps, and DtLatencyTest::time().

Referenced by DtTestManager::addAsyncQueueMsgTimeStamp().

void DtRecipientLatencyTest::addNetReceiveTimeStamp ( unsigned int  testID,
const DtRtiMsg msg 
)
virtual

Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a net receive time stamp.

Implements DtLatencyTest.

References DtLatencyTest::addTransportTypeForTestID(), DtMetadataTypeTimeStampRecipientNetRead, DtRtiMtdTimeStamp::get(), DtLatencyTest::myTestsInProgressTimeStamps, DtLatencyTest::time(), and DtRtiMsg::transportType().

Referenced by DtTestManager::addNetReceiveTimeStamp().

void DtRecipientLatencyTest::addNetSendTimeStamp ( unsigned int  testID,
DtRtiMsg msg 
)
virtual
void DtRecipientLatencyTest::addReceiveInteractionTimeStamp ( unsigned int  testID,
MAKRti::DtTime  timeToUse 
)
virtual

Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a receive interaction time stamp.

Implements DtLatencyTest.

References DtMetadataTypeTimeStampRecipientReceiveInteraction, and DtLatencyTest::myTestsInProgressTimeStamps.

Referenced by DtTestManager::addReceiveInteractionTimeStamp().

void DtRecipientLatencyTest::addSendInteractionTimeStamp ( unsigned int  testID)
virtual

Record the current time and associate it with the input test ID in myTestsInProgressTimeStamp with a send Interaction time stamp.

Implements DtLatencyTest.

References DtMetadataTypeTimeStampRecipientSendInteraction, DtLatencyTest::myTestsInProgressTimeStamps, and DtLatencyTest::time().

Referenced by DtTestManager::addSendInteractionTimeStamp().

DtRecipientLatencyTest& DtRecipientLatencyTest::operator= ( DtRecipientLatencyTest const &  orig)
private

Assignment operator - not allowed.

bool DtRecipientLatencyTest::tick ( )
virtual

Process test activities.

Reimplemented from DtLatencyTest.


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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)