MAK RTIspy API Documentation for HLA 1516
Public Slots | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
DtAssistantLatencyTestMgr Class Reference

Handles activities related to running latency tests and reporting results. More...

+ Inheritance diagram for DtAssistantLatencyTestMgr:
+ Collaboration diagram for DtAssistantLatencyTestMgr:

List of all members.

Public Slots

void processConnectionsUpdate (const DtRtiConnectionAndConfiguration &conns)
 Makes sure updated connections are not for shutdown of the rtiexec used in testing.
void processConnectionsRemoval (const DtRtiConnectionAndConfiguration &conns)
 Makes sure removed connections are not for rtiexec.
void showLrcLatencyTestDialog (int id)
 Display the latency test dialog for the LRC component.
void showRtiexecLatencyTestDialog (const DtRtiConnectionInfoDataPair &, unsigned int federationHdl, const MAKRti::DtString &federationName, unsigned int federateHdl)
 Display the latency test dialog for the rtiexec component.
void processLatencyTestObserve ()
 Processes notification from a latency test dialog that it would like to receive test reports.
void processLatencyTestDismiss ()
 Processes the dismissal of the latency test dialog.
void initiateLatencyTest ()
 Initiates a latency test for the selected component.
void initiateContinuousLatencyTest ()
 Initiate a continuous latency test for the selected component.
void haltContinuousLatencyTest ()
 Stop a continuous latency test for the selected component.
void renameComponent (int id)
 Renames an existing component.
void removeLrcComponent (int id)
 Removes an existing LRC component and its current latency test.
void updateFederateTestStatus (const DtRtiConnectionInfo &conn, const MAKRti::DtString &federationName, unsigned federateHandle)
 Updates the test status of the given federate.
void updateLatencyTestConfig (unsigned int interactionPeriod, unsigned int numInteractions, unsigned int payloadBytes)
 Updates the latency test configuration with the given values.
void setLatencyTestInteractionPeriod (unsigned int)
void setLatencyTestNumInteractions (unsigned int)
void setLatencyTestPayloadBytes (unsigned int)

Public Member Functions

 DtAssistantLatencyTestMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtBoost::shared_ptr< DtAssistantPreferencesInfoMgr > prefMgr, DtBoost::shared_ptr< DtAssistantComponentMgr > compMgr, DtBoost::shared_ptr< DtAssistantConnectionInfoMgr > connInfoMgr, DtBoost::shared_ptr< DtAssistantFederationsInfoMgr > fedInfoMgr, DtBoost::shared_ptr< DtAssistantTrayIconMgr > trayIconMgr)
 Constructor.
virtual ~DtAssistantLatencyTestMgr ()
 Destructor.

Protected Types

typedef std::map
< DtRtiConnectionInfo,
DtAssistantInfoSet
DtRtiexecToObserversMap

Protected Member Functions

bool getRtiexecConn (const DtAssistantMsg &msg, DtRtiConnectionInfoDataPair &exec)
 Fills in the rtiexec connection info based on the message.
bool sendLatencyTestCommand (bool runTest, bool continuous, bool shouldHalt, bool observing)
 Send latency test command message for the currently displayed test.
bool verifyNewTestCanBeRun ()
 Verifies that either no test is currently being run or checks with user.

Protected Attributes

DtBoost::shared_ptr
< DtAssistantPreferencesInfoMgr
myPrefMgr
 The manager that keeps track of Assistant preferences.
DtBoost::shared_ptr
< DtAssistantComponentMgr
myCompMgr
 The manager that keeps track of all local RTI components.
DtBoost::shared_ptr
< DtAssistantConnectionInfoMgr
myConnInfoMgr
 The manager that keeps track of all known RTI connections.
DtBoost::shared_ptr
< DtAssistantFederationsInfoMgr
myFedInfoMgr
 The manager that keeps track of all known federations.
DtBoost::shared_ptr
< DtAssistantTrayIconMgr
myTrayIconMgr
 The manager that handles interactions with the tray icon and its menu.
DtLatencyTestDialogmyLatencyTestDialog
 The latency test dialogs.
DtRtiexecToObserversMap myRemotelyObservedRtiexecs
 List of local rtiexecs and the remote assistants who are observing tests that they are coordinating.
bool myTestViaRtiexec
 Indicates whether the currently displayed latency test is for a test being conducted through an rtiexec.
int myLrcCompId
 The local component ID of the LRC initiating the test (only used if myTestViaRtiexec == false)
DtRtiConnectionInfo myRtiexecConn
 Connection parameters of the rtiexec through which the test is being run (only used if myIsForRtiexec == true)
unsigned int myFederationHdl
 The federation handle of this test (only used if myIsForRtiexec == true)
MAKRti::DtString myFederationName
 The federation name of this test (only used if myIsForRtiexec == true)
unsigned int myInitFederateHdl
 The initiating federate of this test (only used if myIsForRtiexec == true)
unsigned int myInteractionPeriod
 Latency test parameters.
unsigned int myNumInteractions
 Latency test parameters.
unsigned int myPayloadBytes
 Latency test parameters.

Private Member Functions

 DtAssistantLatencyTestMgr (DtAssistantLatencyTestMgr const &)
 Copy Constructor not implemented -- Copy Not Allowed!
DtAssistantLatencyTestMgroperator= (DtAssistantLatencyTestMgr const &)
 Assignment not implemented -- Assignment Not Allowed!

Message Callbacks

Callbacks for latency testing messages

static void processLatencyTestResults (const DtAssistantLatencyReportMsg &msg, void *usr)
 Callback to process a latency test results msg.
static void processTestMgrStatusUpdate (const DtAssistantTestMgrStatusMsg &msg, void *usr)
 Callback to process a test status message from a local LRC component.
static void processTestCommand (const DtAssistantChangeLatencyTestModeMsg &msg, void *usr)
 Callback to process a test command message.
virtual void processLatencyTestResults (const DtAssistantLatencyReportMsg &msg)
 Called by the callback function to process latency results messages.
virtual void processTestMgrStatusUpdate (const DtAssistantTestMgrStatusMsg &msg)
 Called by the callback function to process testMgr status messages from local LRC components.
virtual void processTestCommand (const DtAssistantChangeLatencyTestModeMsg &msg)
 Called by the callback function to process a test command message.

Detailed Description

Handles activities related to running latency tests and reporting results.


Member Typedef Documentation


Constructor & Destructor Documentation

DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr ( DtBoost::shared_ptr< DtRtiAssistantServer server,
DtBoost::shared_ptr< DtRtiAssistantPeer peer,
DtBoost::shared_ptr< DtAssistantPreferencesInfoMgr prefMgr,
DtBoost::shared_ptr< DtAssistantComponentMgr compMgr,
DtBoost::shared_ptr< DtAssistantConnectionInfoMgr connInfoMgr,
DtBoost::shared_ptr< DtAssistantFederationsInfoMgr fedInfoMgr,
DtBoost::shared_ptr< DtAssistantTrayIconMgr trayIconMgr 
)

Copy Constructor not implemented -- Copy Not Allowed!


Member Function Documentation

Stop a continuous latency test for the selected component.

If one is not running, this is a nop at the component endpoint.

References sendLatencyTestCommand().

Referenced by DtAssistantLatencyTestMgr().

Initiate a continuous latency test for the selected component.

References sendLatencyTestCommand().

Referenced by DtAssistantLatencyTestMgr().

Initiates a latency test for the selected component.

References sendLatencyTestCommand().

Referenced by DtAssistantLatencyTestMgr().

DtAssistantLatencyTestMgr& DtAssistantLatencyTestMgr::operator= ( DtAssistantLatencyTestMgr const &  ) [private]

Assignment not implemented -- Assignment Not Allowed!

Makes sure updated connections are not for shutdown of the rtiexec used in testing.

References DtRtiConnectionAndConfiguration::connections(), DtLatencyTestDialog::indicateRtiexecShutdown(), myLatencyTestDialog, myRtiexecConn, and myTestViaRtiexec.

Referenced by DtAssistantLatencyTestMgr().

Processes notification from a latency test dialog that it would like to receive test reports.

References sendLatencyTestCommand().

Referenced by DtAssistantLatencyTestMgr().

void DtAssistantLatencyTestMgr::processLatencyTestResults ( const DtAssistantLatencyReportMsg msg,
void *  usr 
) [static, protected]

Callback to process a latency test results msg.

Referenced by DtAssistantLatencyTestMgr(), and ~DtAssistantLatencyTestMgr().

void DtAssistantLatencyTestMgr::processTestCommand ( const DtAssistantChangeLatencyTestModeMsg msg,
void *  usr 
) [static, protected]

Callback to process a test command message.

Referenced by DtAssistantLatencyTestMgr(), and ~DtAssistantLatencyTestMgr().

void DtAssistantLatencyTestMgr::processTestMgrStatusUpdate ( const DtAssistantTestMgrStatusMsg msg,
void *  usr 
) [static, protected]

Callback to process a test status message from a local LRC component.

Referenced by DtAssistantLatencyTestMgr(), and ~DtAssistantLatencyTestMgr().

Removes an existing LRC component and its current latency test.

References DtLatencyTestDialog::indicateFederateResigned(), myLatencyTestDialog, myLrcCompId, and myTestViaRtiexec.

Referenced by DtAssistantLatencyTestMgr().

bool DtAssistantLatencyTestMgr::sendLatencyTestCommand ( bool  runTest,
bool  continuous,
bool  shouldHalt,
bool  observing 
) [protected]
void DtAssistantLatencyTestMgr::setLatencyTestInteractionPeriod ( unsigned int  period) [slot]

References myInteractionPeriod, and period.

Referenced by DtAssistantLatencyTestMgr().

References myNumInteractions.

Referenced by DtAssistantLatencyTestMgr().

void DtAssistantLatencyTestMgr::setLatencyTestPayloadBytes ( unsigned int  bytes) [slot]

References myPayloadBytes.

Referenced by DtAssistantLatencyTestMgr().

void DtAssistantLatencyTestMgr::showRtiexecLatencyTestDialog ( const DtRtiConnectionInfoDataPair exec,
unsigned int  federationHdl,
const MAKRti::DtString &  federationName,
unsigned int  federateHdl 
) [slot]
void DtAssistantLatencyTestMgr::updateFederateTestStatus ( const DtRtiConnectionInfo conn,
const MAKRti::DtString &  federationName,
unsigned  federateHandle 
) [slot]
void DtAssistantLatencyTestMgr::updateLatencyTestConfig ( unsigned int  interactionPeriod,
unsigned int  numInteractions,
unsigned int  payloadBytes 
) [slot]

Updates the latency test configuration with the given values.

References myPrefMgr.

Referenced by DtAssistantLatencyTestMgr().


Member Data Documentation

The manager that keeps track of all known RTI connections.

Referenced by DtAssistantLatencyTestMgr(), getRtiexecConn(), sendLatencyTestCommand(), and showRtiexecLatencyTestDialog().

The federation handle of this test (only used if myIsForRtiexec == true)

Referenced by processLatencyTestResults(), sendLatencyTestCommand(), and showRtiexecLatencyTestDialog().

MAKRti::DtString DtAssistantLatencyTestMgr::myFederationName [protected]

The federation name of this test (only used if myIsForRtiexec == true)

Referenced by showRtiexecLatencyTestDialog(), and updateFederateTestStatus().

The manager that keeps track of all known federations.

Referenced by DtAssistantLatencyTestMgr(), and updateFederateTestStatus().

The initiating federate of this test (only used if myIsForRtiexec == true)

Referenced by processLatencyTestResults(), sendLatencyTestCommand(), showRtiexecLatencyTestDialog(), and updateFederateTestStatus().

The local component ID of the LRC initiating the test (only used if myTestViaRtiexec == false)

Referenced by processLatencyTestDismiss(), processLatencyTestResults(), processTestMgrStatusUpdate(), removeLrcComponent(), renameComponent(), sendLatencyTestCommand(), and showLrcLatencyTestDialog().

The manager that keeps track of Assistant preferences.

Referenced by DtAssistantLatencyTestMgr(), and updateLatencyTestConfig().

List of local rtiexecs and the remote assistants who are observing tests that they are coordinating.

Referenced by processLatencyTestDismiss(), processLatencyTestResults(), and processTestCommand().

Connection parameters of the rtiexec through which the test is being run (only used if myIsForRtiexec == true)

Referenced by processConnectionsRemoval(), processConnectionsUpdate(), processLatencyTestDismiss(), processLatencyTestResults(), processTestCommand(), sendLatencyTestCommand(), showRtiexecLatencyTestDialog(), and updateFederateTestStatus().

The manager that handles interactions with the tray icon and its menu.

Referenced by DtAssistantLatencyTestMgr(), and processTestMgrStatusUpdate().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)