MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Slots | Signals | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes

Dialog which displays the results of network latency testing for a particular initiating federate. More...

+ Inheritance diagram for DtLatencyTestDialog:
+ Collaboration diagram for DtLatencyTestDialog:

Classes

struct  DtDetailedInfo
 Structure to store detailed information. More...

Public Slots

virtual void processRun ()
 Process the pressing of the run button.
virtual void processContinuous ()
 Process the pressing of the continuous button.
virtual void processStop ()
 Process the pressing of the stop button.
virtual void processSave ()
 Process the pressing of the save button.
virtual void processSelectionChange ()
 Process the selection of a new item in the table.
virtual void setTestConfig (unsigned int interactionPeriod, unsigned int numInteractions, unsigned int payloadBytes)
 Set test configuration values.

Signals

void run ()
 Signal emitted when run button is pressed.
void runContinuous ()
 Signal emitted when run button is pressed in continuous mode.
void stopRunning ()
 Signal emitted when stop button is pressed.
void dismiss ()
 Signal emitted when the dialog is closed or dismissed.
void updateTestConfig (unsigned int interactionPeriod, unsigned int numInteractions, unsigned int payloadBytes)
 Signal emitted when test configuration is updated.
void observing ()
 Signal emitted when the dialog is ready to receive test reports.

Public Member Functions

 DtLatencyTestDialog (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructor.
virtual ~DtLatencyTestDialog ()
 Destructor.
virtual void clearResults ()
 Clears the displayed results.
virtual void addResult (const QString &initName, unsigned int initHandle, const QString &recipName, unsigned int recipHandle, DtRIDParameters::DtAsynchronousIOModeEnum initProcModel, DtRIDParameters::DtAsynchronousIOModeEnum recipProcModel, unsigned int initTickTime, unsigned int recipTickTime, unsigned int bestEffortRoundTripTime, unsigned int reliableRoundTripTime, int initBestEffortQTime, int recipBestEffortQTime, int initReliableQTime, int recipReliableQTime)
 Adds a new test result.
virtual void addTimeoutResult (const QString &recipName, unsigned int recipHandle)
 Adds a new timeout test result.
virtual void setName (const QString &name)
 Renames the component.
virtual void updateStatus (bool enabled, bool capable, bool continuous, bool inProgress)
 Updates the testing status.
virtual void indicateFederateResigned ()
 Indicate on the dialog that federate has resigned.
virtual void indicateRtiexecShutdown ()
 Indicate on the dialog that rtiexec has shutdown.
virtual bool isTestInProgress ()
 Returns true if a test is currently in progress.
virtual void closeWithoutPrompt ()
 Closes the dialog without displaying a prompt, even if a test is in progress.

Protected Types

enum  DtResultsTableCol { RecipientCol, TransitTimeCol, TimeWaitingCol, TotalTimeCol }
 Enumeration for the table columns. More...
typedef std::map< int,
DtDetailedInfo * > 
DtHandleToDetailedInfoMap
 Typedef for map of recipient handle to detailed info.

Protected Member Functions

virtual void getWidgetsToUpdate (unsigned int recipHandle, QTableWidgetItem *&recipItem, QTableWidgetItem *&timeWaitingItem, QTableWidgetItem *&transitTimeItem, QTableWidgetItem *&totalTimeItem, DtDetailedInfo *&details)
 Gets the widgets in the dialog that should be updated to display the test results for the given recipient name.
virtual QString federateNameToDisplay (unsigned int handle, const QString &name=QString::null)
 Creates the string to be used in the GUI display for the given federate.
virtual unsigned int handleFromDisplayName (const QString &name)
 Returns the handle from the displayed federate name.
virtual QString procModelString (DtRIDParameters::DtAsynchronousIOModeEnum procModel)
 Converts the processing model value to a string.
virtual void clearDetailsDisplay ()
 Clears the detailed information display.
virtual void setTitle ()
 Updates the title of the dialog.
virtual void closeEvent (QCloseEvent *event)
 Handles the closing of the window.
virtual void showEvent (QShowEvent *event)
 Prepare the dialog to be shown.
virtual void convertToMsString (unsigned int usec, QString &result, const QString &notAvailableString=theLongNAString, bool zeroIsNotAvailable=true)
 Converts from usec to a string displaying msec.
virtual void convertToMsString (int usec, QString &result, const QString &notAvailableString=theLongNAString, bool zeroIsNotAvailable=true)
 Converts from usec to a string displaying msec.

Protected Attributes

Ui::LatencyTestDialog myUiImpl
QString myName
 Name of the initiating federate.
QString myStatusText
 Text which displays the current status.
DtHandleToDetailedInfoMap myDetailedInfo
 Map of recipient handles to more detailed information.
DtLatencyTestConfigWidgetmyConfigWidget
 The widget which configures latency test parameters.
bool myTestingEnabled
 Stores whether or not testing is enabled.
bool myTestCapable
 Stores whether or not the LRC is currently capable of running a test.
bool myTestInProgress
 Stores whether or not a test is in progress.
bool myContinuous
 Stores whether or not the current test is continuous.
QIcon myContinuousIcon
 Icon for the continuous button when it is not depressed.
QString mySavedFile
 The previously saved file.
bool myCloseWithoutPrompt
 Indicates that no prompt should be displayed when the dialog is closed.

Static Protected Attributes

static const QString theShortNAString
 Short string used to indicate metric is not available.
static const QString theLongNAString
 Longer string used to indicate metric is not available.
static const QString theInitiatorToolTip
 Tool tip text for the displayed information.
static const QString theRecipientToolTip
 Tool tip text for the displayed information.
static const QString theTimeWaitingToolTip
 Tool tip text for the displayed information.
static const QString theTransitTimeToolTip
 Tool tip text for the displayed information.
static const QString theTotalTimeToolTip
 Tool tip text for the displayed information.
static const QString theTimestampToolTip
 Tool tip text for the displayed information.
static const QString theProcModelToolTip
 Tool tip text for the displayed information.
static const QString theTickTimeToolTip
 Tool tip text for the displayed information.
static const QString theQTimeToolTip
 Tool tip text for the displayed information.
static const QString theRunButtonToolTip
 Tool tip text for the dialog buttons.
static const QString theStopButtonToolTip
 Tool tip text for the dialog buttons.
static const QString theContinuousButtonToolTip
 Tool tip text for the dialog buttons.
static const QString theConfigureButtonToolTip
 Tool tip text for the dialog buttons.
static const QString theSaveButtonToolTip
 Tool tip text for the dialog buttons.

Detailed Description

Dialog which displays the results of network latency testing for a particular initiating federate.

Member Typedef Documentation

Typedef for map of recipient handle to detailed info.

Member Enumeration Documentation

Enumeration for the table columns.

Enumerator:
RecipientCol 
TransitTimeCol 
TimeWaitingCol 
TotalTimeCol 

Constructor & Destructor Documentation

DtLatencyTestDialog::DtLatencyTestDialog ( QWidget parent = 0,
Qt::WindowFlags  f = 0 
)

Constructor.

virtual DtLatencyTestDialog::~DtLatencyTestDialog ( )
virtual

Destructor.

Member Function Documentation

virtual void DtLatencyTestDialog::addResult ( const QString &  initName,
unsigned int  initHandle,
const QString &  recipName,
unsigned int  recipHandle,
DtRIDParameters::DtAsynchronousIOModeEnum  initProcModel,
DtRIDParameters::DtAsynchronousIOModeEnum  recipProcModel,
unsigned int  initTickTime,
unsigned int  recipTickTime,
unsigned int  bestEffortRoundTripTime,
unsigned int  reliableRoundTripTime,
int  initBestEffortQTime,
int  recipBestEffortQTime,
int  initReliableQTime,
int  recipReliableQTime 
)
virtual

Adds a new test result.

virtual void DtLatencyTestDialog::addTimeoutResult ( const QString &  recipName,
unsigned int  recipHandle 
)
virtual

Adds a new timeout test result.

virtual void DtLatencyTestDialog::clearDetailsDisplay ( )
protectedvirtual

Clears the detailed information display.

virtual void DtLatencyTestDialog::clearResults ( )
virtual

Clears the displayed results.

virtual void DtLatencyTestDialog::closeEvent ( QCloseEvent *  event)
protectedvirtual

Handles the closing of the window.

virtual void DtLatencyTestDialog::closeWithoutPrompt ( )
virtual

Closes the dialog without displaying a prompt, even if a test is in progress.

virtual void DtLatencyTestDialog::convertToMsString ( unsigned int  usec,
QString &  result,
const QString &  notAvailableString = theLongNAString,
bool  zeroIsNotAvailable = true 
)
protectedvirtual

Converts from usec to a string displaying msec.

virtual void DtLatencyTestDialog::convertToMsString ( int  usec,
QString &  result,
const QString &  notAvailableString = theLongNAString,
bool  zeroIsNotAvailable = true 
)
protectedvirtual

Converts from usec to a string displaying msec.

void DtLatencyTestDialog::dismiss ( )
signal

Signal emitted when the dialog is closed or dismissed.

virtual QString DtLatencyTestDialog::federateNameToDisplay ( unsigned int  handle,
const QString &  name = QString::null 
)
protectedvirtual

Creates the string to be used in the GUI display for the given federate.

virtual void DtLatencyTestDialog::getWidgetsToUpdate ( unsigned int  recipHandle,
QTableWidgetItem *&  recipItem,
QTableWidgetItem *&  timeWaitingItem,
QTableWidgetItem *&  transitTimeItem,
QTableWidgetItem *&  totalTimeItem,
DtDetailedInfo *&  details 
)
protectedvirtual

Gets the widgets in the dialog that should be updated to display the test results for the given recipient name.

virtual unsigned int DtLatencyTestDialog::handleFromDisplayName ( const QString &  name)
protectedvirtual

Returns the handle from the displayed federate name.

virtual void DtLatencyTestDialog::indicateFederateResigned ( )
virtual

Indicate on the dialog that federate has resigned.

virtual void DtLatencyTestDialog::indicateRtiexecShutdown ( )
virtual

Indicate on the dialog that rtiexec has shutdown.

virtual bool DtLatencyTestDialog::isTestInProgress ( )
virtual

Returns true if a test is currently in progress.

void DtLatencyTestDialog::observing ( )
signal

Signal emitted when the dialog is ready to receive test reports.

virtual void DtLatencyTestDialog::processContinuous ( )
virtualslot

Process the pressing of the continuous button.

virtual void DtLatencyTestDialog::processRun ( )
virtualslot

Process the pressing of the run button.

virtual void DtLatencyTestDialog::processSave ( )
virtualslot

Process the pressing of the save button.

virtual void DtLatencyTestDialog::processSelectionChange ( )
virtualslot

Process the selection of a new item in the table.

virtual void DtLatencyTestDialog::processStop ( )
virtualslot

Process the pressing of the stop button.

virtual QString DtLatencyTestDialog::procModelString ( DtRIDParameters::DtAsynchronousIOModeEnum  procModel)
protectedvirtual

Converts the processing model value to a string.

void DtLatencyTestDialog::run ( )
signal

Signal emitted when run button is pressed.

void DtLatencyTestDialog::runContinuous ( )
signal

Signal emitted when run button is pressed in continuous mode.

virtual void DtLatencyTestDialog::setName ( const QString &  name)
virtual

Renames the component.

virtual void DtLatencyTestDialog::setTestConfig ( unsigned int  interactionPeriod,
unsigned int  numInteractions,
unsigned int  payloadBytes 
)
virtualslot

Set test configuration values.

virtual void DtLatencyTestDialog::setTitle ( )
protectedvirtual

Updates the title of the dialog.

virtual void DtLatencyTestDialog::showEvent ( QShowEvent *  event)
protectedvirtual

Prepare the dialog to be shown.

void DtLatencyTestDialog::stopRunning ( )
signal

Signal emitted when stop button is pressed.

virtual void DtLatencyTestDialog::updateStatus ( bool  enabled,
bool  capable,
bool  continuous,
bool  inProgress 
)
virtual

Updates the testing status.

void DtLatencyTestDialog::updateTestConfig ( unsigned int  interactionPeriod,
unsigned int  numInteractions,
unsigned int  payloadBytes 
)
signal

Signal emitted when test configuration is updated.

Member Data Documentation

bool DtLatencyTestDialog::myCloseWithoutPrompt
protected

Indicates that no prompt should be displayed when the dialog is closed.

DtLatencyTestConfigWidget* DtLatencyTestDialog::myConfigWidget
protected

The widget which configures latency test parameters.

bool DtLatencyTestDialog::myContinuous
protected

Stores whether or not the current test is continuous.

QIcon DtLatencyTestDialog::myContinuousIcon
protected

Icon for the continuous button when it is not depressed.

DtHandleToDetailedInfoMap DtLatencyTestDialog::myDetailedInfo
protected

Map of recipient handles to more detailed information.

QString DtLatencyTestDialog::myName
protected

Name of the initiating federate.

QString DtLatencyTestDialog::mySavedFile
protected

The previously saved file.

QString DtLatencyTestDialog::myStatusText
protected

Text which displays the current status.

bool DtLatencyTestDialog::myTestCapable
protected

Stores whether or not the LRC is currently capable of running a test.

bool DtLatencyTestDialog::myTestingEnabled
protected

Stores whether or not testing is enabled.

bool DtLatencyTestDialog::myTestInProgress
protected

Stores whether or not a test is in progress.

Ui::LatencyTestDialog DtLatencyTestDialog::myUiImpl
protected
const QString DtLatencyTestDialog::theConfigureButtonToolTip
staticprotected

Tool tip text for the dialog buttons.

const QString DtLatencyTestDialog::theContinuousButtonToolTip
staticprotected

Tool tip text for the dialog buttons.

const QString DtLatencyTestDialog::theInitiatorToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theLongNAString
staticprotected

Longer string used to indicate metric is not available.

const QString DtLatencyTestDialog::theProcModelToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theQTimeToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theRecipientToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theRunButtonToolTip
staticprotected

Tool tip text for the dialog buttons.

const QString DtLatencyTestDialog::theSaveButtonToolTip
staticprotected

Tool tip text for the dialog buttons.

const QString DtLatencyTestDialog::theShortNAString
staticprotected

Short string used to indicate metric is not available.

const QString DtLatencyTestDialog::theStopButtonToolTip
staticprotected

Tool tip text for the dialog buttons.

const QString DtLatencyTestDialog::theTickTimeToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theTimestampToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theTimeWaitingToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theTotalTimeToolTip
staticprotected

Tool tip text for the displayed information.

const QString DtLatencyTestDialog::theTransitTimeToolTip
staticprotected

Tool tip text for the displayed information.


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

Document ID: Generated on Fri Sep 27 00:57:56 EDT 2019 from SVN revision 201708
Copyright © 2005-2018 VT MÄK Inc. All Rights Reserved (www.mak.com)