DtAssistantLatencyTestMgr Class Reference

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

Inheritance diagram for DtAssistantLatencyTestMgr:

Collaboration diagram for DtAssistantLatencyTestMgr:

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 (const DtAssistantComponentInfo *)
	Renames an existing component.
void	removeLrcComponent (const DtAssistantComponentInfo *)
	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 Slots inherited from DtAssistantMgr
void	displayWarningDialogs ()
	Displays all warning dialogs.

Signals
void	updateLatencyTestInteractionPeriod (unsigned int)
	Updates the period between latency test interactions.
void	updateLatencyTestNumInteractions (unsigned int)
	Updates the number of interactions per latency test.
void	updateLatencyTestPayloadBytes (unsigned int)
	Updates the size of a latency test interaction payload in bytes.
void	disableComponentLatencyTest (int)
	Disables latency testing for the given component.
void	enableComponentLatencyTest (int)
	Enables latency testing for the given component.
Signals inherited from DtAssistantMgr
void	warningDialogDisplayed ()
	Emitted when a warning dialog is displayed.
void	warningDialogDismissed ()
	Emitted when a warning dialog is dismissed.
void	popupRequested (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	popupRequested (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId, bool logOnly)
	Emitted when a notification should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source, bool logOnly)
	Emitted when a notification should be displayed.

Public Member Functions
	DtAssistantLatencyTestMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, DtBoost::shared_ptr< DtAssistantComponentMgr > compMgr, DtBoost::shared_ptr< DtAssistantConnectionInfoMgr > connInfoMgr, DtBoost::shared_ptr< DtAssistantFederationsInfoMgr > fedInfoMgr)
	Constructor.
virtual	~DtAssistantLatencyTestMgr ()
	Destructor.
Public Member Functions inherited from DtAssistantMgr
	DtAssistantMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
	Constructor.
virtual	~DtAssistantMgr ()
	Destructor.
virtual void	initialize ()
	Initializes this manager just prior to beginning assistant processing.
virtual void	tick ()
	Performs tasks that need to be completed periodically.
virtual void	startShutdown ()
	Performs any necessary processing at the start of shutdown.
virtual bool	dialogsVisible () const
	Determines if there are any visible dialogs for which this manager is responsible.
virtual void	configWidget (DtAssistantConfigWidget **widget, QIcon &icon, QString &name, DtPreferencesPage &pageId)
	Retrieves a widget which will be placed in the configuration dialog for configuring user preferences.
virtual void	updateConfigWidget ()
	Forces the configuration widget to be updated.
virtual void	processConfigWidgetAccept ()
	Process the changes that were accepted in the configuration widget.

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 Member Functions inherited from DtAssistantMgr
void	startDialog (QDialog *dlg, bool inTaskbar, bool warningDialog)
	Sets up the given widget as a dialog.
void	finishDialog (QDialog *dlg)
	Should be called prior to deleting any dialog started with startDialog.
void	showDialog (QDialog *dlg)
	Shows the dialog.
void	startMainWindow (QMainWindow *dlg)
	Sets up a main window dialog.
void	finishMainWindow (QMainWindow *dlg)
	Should be called prior to deleting any dialog started with startMainWindow.
void	showMainWindow (QMainWindow *dlg)
	Shows the dialog.
void	showPopup (const MAKRti::DtString &text, int sourceCompId=-1, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and name of the given source component.
void	showPopup (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and source name.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Displays and logs a notification from the given component.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Displays and logs notification with the given component name.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Logs a notification from the given component, does not display.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Logs a notification with the given component name, does not display.

Protected Attributes
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.
DtLatencyTestDialog *	myLatencyTestDialog
	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.
Protected Attributes inherited from DtAssistantMgr
DtBoost::shared_ptr < DtRtiAssistantServer >	myServer
	The Assistant server from which new messages will arrive from local RTI components.
DtBoost::shared_ptr < DtRtiAssistantPeer >	myPeer
	The Assistant peer which communicates with other Assistants.
std::set< QDialog * >	myUnparentedDialogs
	All unparented dialogs that are created by the GUI should be added to this set.
std::set< QMainWindow * >	myMainWindows
	All main windows that are created by the GUI should be added to this set.
std::set< QDialog * >	myWarningDialogs
	Set of the popup dialogs, either parented or unparented, which, when active, should cause a warning icon to be displayed.

Private Member Functions
	DtAssistantLatencyTestMgr (DtAssistantLatencyTestMgr const &)
	Copy Constructor not implemented – Copy Not Allowed!
DtAssistantLatencyTestMgr &	operator= (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.

Additional Inherited Members
Static Protected Attributes inherited from DtAssistantMgr
static QIcon	theRtiIcon
	The icons used by the RTI Assistant.
static QIcon	theSmallRtiIcon
static QIcon	theWebIcon
static QIcon	theNotifyRtiIcon
static QIcon	theWarningRtiIcon
static QIcon	thePreferencesIcon
static QIcon	theAboutIcon
static QIcon	theHelpIcon
static bool	theIconsAreLoaded
	Whether or not the icons have yet been loaded.

Detailed Description

Handles activities related to running latency tests and reporting results.

Member Typedef Documentation

typedef std::map< DtRtiConnectionInfo, DtAssistantInfoSet > DtAssistantLatencyTestMgr::DtRtiexecToObserversMap

protected

Constructor & Destructor Documentation

DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr	(	DtBoost::shared_ptr< DtRtiAssistantServer >	server,
		DtBoost::shared_ptr< DtRtiAssistantPeer >	peer,
		DtAssistantSignalRouter &	signalRouter,
		DtBoost::shared_ptr< DtAssistantComponentMgr >	compMgr,
		DtBoost::shared_ptr< DtAssistantConnectionInfoMgr >	connInfoMgr,
		DtBoost::shared_ptr< DtAssistantFederationsInfoMgr >	fedInfoMgr
	)

Constructor.

virtual DtAssistantLatencyTestMgr::~DtAssistantLatencyTestMgr ( )

virtual

Destructor.

DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr ( DtAssistantLatencyTestMgr const &  )

private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

void DtAssistantLatencyTestMgr::disableComponentLatencyTest ( int  )

signal

Disables latency testing for the given component.

void DtAssistantLatencyTestMgr::enableComponentLatencyTest ( int  )

signal

Enables latency testing for the given component.

bool DtAssistantLatencyTestMgr::getRtiexecConn ( const DtAssistantMsg &  msg, DtRtiConnectionInfoDataPair &  exec  )

protected

Fills in the rtiexec connection info based on the message.

void DtAssistantLatencyTestMgr::haltContinuousLatencyTest ( )

slot

Stop a continuous latency test for the selected component.

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

void DtAssistantLatencyTestMgr::initiateContinuousLatencyTest ( )

slot

Initiate a continuous latency test for the selected component.

void DtAssistantLatencyTestMgr::initiateLatencyTest ( )

slot

Initiates a latency test for the selected component.

DtAssistantLatencyTestMgr& DtAssistantLatencyTestMgr::operator= ( DtAssistantLatencyTestMgr const &  )

private

Assignment not implemented – Assignment Not Allowed!

void DtAssistantLatencyTestMgr::processConnectionsRemoval ( const DtRtiConnectionAndConfiguration &  conns )

slot

Makes sure removed connections are not for rtiexec.

void DtAssistantLatencyTestMgr::processConnectionsUpdate ( const DtRtiConnectionAndConfiguration &  conns )

slot

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

void DtAssistantLatencyTestMgr::processLatencyTestDismiss ( )

slot

Processes the dismissal of the latency test dialog.

void DtAssistantLatencyTestMgr::processLatencyTestObserve ( )

slot

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

static void DtAssistantLatencyTestMgr::processLatencyTestResults ( const DtAssistantLatencyReportMsg &  msg, void *  usr  )

staticprotected

Callback to process a latency test results msg.

virtual void DtAssistantLatencyTestMgr::processLatencyTestResults ( const DtAssistantLatencyReportMsg &  msg )

protectedvirtual

Called by the callback function to process latency results messages.

static void DtAssistantLatencyTestMgr::processTestCommand ( const DtAssistantChangeLatencyTestModeMsg &  msg, void *  usr  )

staticprotected

Callback to process a test command message.

virtual void DtAssistantLatencyTestMgr::processTestCommand ( const DtAssistantChangeLatencyTestModeMsg &  msg )

protectedvirtual

Called by the callback function to process a test command message.

static void DtAssistantLatencyTestMgr::processTestMgrStatusUpdate ( const DtAssistantTestMgrStatusMsg &  msg, void *  usr  )

staticprotected

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

virtual void DtAssistantLatencyTestMgr::processTestMgrStatusUpdate ( const DtAssistantTestMgrStatusMsg &  msg )

protectedvirtual

Called by the callback function to process testMgr status messages from local LRC components.

void DtAssistantLatencyTestMgr::removeLrcComponent ( const DtAssistantComponentInfo *  )

slot

Removes an existing LRC component and its current latency test.

void DtAssistantLatencyTestMgr::renameComponent ( const DtAssistantComponentInfo *  )

slot

Renames an existing component.

bool DtAssistantLatencyTestMgr::sendLatencyTestCommand ( bool  runTest, bool  continuous, bool  shouldHalt, bool  observing  )

protected

Send latency test command message for the currently displayed test.

void DtAssistantLatencyTestMgr::setLatencyTestInteractionPeriod ( unsigned  int )

slot

void DtAssistantLatencyTestMgr::setLatencyTestNumInteractions ( unsigned  int )

slot

void DtAssistantLatencyTestMgr::setLatencyTestPayloadBytes ( unsigned  int )

slot

void DtAssistantLatencyTestMgr::showLrcLatencyTestDialog ( int  id )

slot

Display the latency test dialog for the LRC component.

void DtAssistantLatencyTestMgr::showRtiexecLatencyTestDialog ( const DtRtiConnectionInfoDataPair &  , unsigned int  federationHdl, const MAKRti::DtString &  federationName, unsigned int  federateHdl  )

slot

Display the latency test dialog for the rtiexec component.

void DtAssistantLatencyTestMgr::updateFederateTestStatus ( const DtRtiConnectionInfo &  conn, const MAKRti::DtString &  federationName, unsigned  federateHandle  )

slot

Updates the test status of the given federate.

void DtAssistantLatencyTestMgr::updateLatencyTestConfig ( unsigned int  interactionPeriod, unsigned int  numInteractions, unsigned int  payloadBytes  )

slot

Updates the latency test configuration with the given values.

void DtAssistantLatencyTestMgr::updateLatencyTestInteractionPeriod ( unsigned  int )

signal

Updates the period between latency test interactions.

void DtAssistantLatencyTestMgr::updateLatencyTestNumInteractions ( unsigned  int )

signal

Updates the number of interactions per latency test.

void DtAssistantLatencyTestMgr::updateLatencyTestPayloadBytes ( unsigned  int )

signal

Updates the size of a latency test interaction payload in bytes.

bool DtAssistantLatencyTestMgr::verifyNewTestCanBeRun ( )

protected

Verifies that either no test is currently being run or checks with user.

Member Data Documentation

DtBoost::shared_ptr<DtAssistantComponentMgr> DtAssistantLatencyTestMgr::myCompMgr

protected

The manager that keeps track of all local RTI components.

DtBoost::shared_ptr<DtAssistantConnectionInfoMgr> DtAssistantLatencyTestMgr::myConnInfoMgr

protected

The manager that keeps track of all known RTI connections.

unsigned int DtAssistantLatencyTestMgr::myFederationHdl

protected

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

MAKRti::DtString DtAssistantLatencyTestMgr::myFederationName

protected

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

DtBoost::shared_ptr<DtAssistantFederationsInfoMgr> DtAssistantLatencyTestMgr::myFedInfoMgr

protected

The manager that keeps track of all known federations.

unsigned int DtAssistantLatencyTestMgr::myInitFederateHdl

protected

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

unsigned int DtAssistantLatencyTestMgr::myInteractionPeriod

protected

Latency test parameters.

DtLatencyTestDialog* DtAssistantLatencyTestMgr::myLatencyTestDialog

protected

The latency test dialogs.

int DtAssistantLatencyTestMgr::myLrcCompId

protected

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

unsigned int DtAssistantLatencyTestMgr::myNumInteractions

protected

Latency test parameters.

unsigned int DtAssistantLatencyTestMgr::myPayloadBytes

protected

Latency test parameters.

DtRtiexecToObserversMap DtAssistantLatencyTestMgr::myRemotelyObservedRtiexecs

protected

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

DtRtiConnectionInfo DtAssistantLatencyTestMgr::myRtiexecConn

protected

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

bool DtAssistantLatencyTestMgr::myTestViaRtiexec

protected

Indicates whether the currently displayed latency test is for a test being conducted through an rtiexec.

---

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

• latencyTestMgr.h