MAK RTIspy API Documentation for HLA 1516
Signals | Public Member Functions | Protected Attributes | Static Protected Attributes
DtAssistantComponentMenu Class Reference

This class defines the menu of options available to all RTI components from the RTI Assistant GUI. More...

+ Inheritance diagram for DtAssistantComponentMenu:
+ Collaboration diagram for DtAssistantComponentMenu:

List of all members.

Public Slots

virtual void openWebSpy ()
 Slots to handle the selection of each of the menu actions.
virtual void showLog ()
 Slots to handle the selection of each of the menu actions.
virtual void enableLogging ()
 Slots to handle the selection of each of the menu actions.
virtual void exitComponent ()
 Slots to handle the selection of each of the menu actions.
virtual void showLatencyTestDialog ()
 Slots to handle the selection of each of the menu actions.
virtual void displayFederateInfo ()
 Slots to handle the selection of each of the menu actions.

Signals

void openWebSpySelected (int id)
 Signals that indicate a menu action has been selected, passing the component's ID.
void showLogSelected (int id)
void enableLoggingSelected (int id)
void exitSelected (int id)
void showLatencyTestDialogSelected (int id)
void displayFederateInfo (int id)

Public Member Functions

 DtAssistantComponentMenu (const QString &name, int id, DtAssistantComponentType type, QWidget *parent=0)
 Constructor.
virtual ~DtAssistantComponentMenu ()
 Destructor.
virtual bool webSpyEnabled () const
 Whether or not the web spy menu option is enabled.
virtual void enableWebSpy (bool enable)
 Enables or disables the open web spy menu option.
virtual bool showLogEnabled () const
 Whether or not the show log menu option is enabled.
virtual void enableShowLog (bool enable)
 Enables or disables the show log menu option.
virtual bool latencyTestEnabled () const
 Whether or not the latency test menu option is enabled.
virtual void enableLatencyTest (bool enable)
 Set whether latency testing is enabled.
virtual DtAssistantComponentType type ()
 Returns the type of this component.
virtual int id ()
 Returns the ID of this component.
virtual QString name ()
 Returns the ID of this component.
virtual void rename (const QString &newName)
 Changes the name for this component.

Protected Attributes

DtAssistantComponentType myType
 The component type of this menu.
int myId
 The ID of the component.
QString myName
 The name of the component.
QAction * myWebSpyAction
 Action to load the web spy page for this component.
QAction * myLogAction
 Action to show the log of this component.
QAction * myEnableLoggingAction
 Action to enable logging for this component.
QAction * myExitAction
 Action to force this component to exit.
QAction * myFederateInfoAction
 Action to show the federate information.
QAction * myLatencyTestAction
 Action to open the latency test dialog for this component.

Static Protected Attributes

static const unsigned theMaxNameSize = 25
 The maximum length name that can be displayed.

Detailed Description

This class defines the menu of options available to all RTI components from the RTI Assistant GUI.


Constructor & Destructor Documentation

DtAssistantComponentMenu::DtAssistantComponentMenu ( const QString &  name,
int  id,
DtAssistantComponentType  type,
QWidget parent = 0 
)

Destructor.


Member Function Documentation

Slots to handle the selection of each of the menu actions.

References myId.

Referenced by DtAssistantComponentMenu().

Set whether latency testing is enabled.

References myLatencyTestAction.

void DtAssistantComponentMenu::enableLogging ( ) [virtual, slot]

Slots to handle the selection of each of the menu actions.

References enableLoggingSelected(), and myId.

Referenced by DtAssistantComponentMenu().

Referenced by enableLogging().

void DtAssistantComponentMenu::enableShowLog ( bool  enable) [virtual]

Enables or disables the show log menu option.

Disables the logging enable menu option.

References myEnableLoggingAction, and myLogAction.

Referenced by DtAssistantTrayIconMgr::disableComponentLog(), and DtAssistantTrayIconMgr::enableComponentLog().

void DtAssistantComponentMenu::enableWebSpy ( bool  enable) [virtual]

Enables or disables the open web spy menu option.

References myWebSpyAction.

Referenced by DtAssistantTrayIconMgr::disableComponentWebSpy(), and DtAssistantTrayIconMgr::enableComponentWebSpy().

void DtAssistantComponentMenu::exitComponent ( ) [virtual, slot]

Slots to handle the selection of each of the menu actions.

References exitSelected(), and myId.

Referenced by DtAssistantComponentMenu().

void DtAssistantComponentMenu::exitSelected ( int  id) [signal]

Referenced by exitComponent().

int DtAssistantComponentMenu::id ( ) [virtual]

Whether or not the latency test menu option is enabled.

References myLatencyTestAction.

QString DtAssistantComponentMenu::name ( ) [virtual]

Returns the ID of this component.

References myName.

void DtAssistantComponentMenu::openWebSpy ( ) [virtual, slot]

Slots to handle the selection of each of the menu actions.

References myId, and openWebSpySelected().

Referenced by DtAssistantComponentMenu().

Signals that indicate a menu action has been selected, passing the component's ID.

Referenced by openWebSpy().

void DtAssistantComponentMenu::rename ( const QString &  newName) [virtual]

Changes the name for this component.

References myName, and theMaxNameSize.

Referenced by DtAssistantComponentMenu(), and DtAssistantTrayIconMgr::renameComponent().

Slots to handle the selection of each of the menu actions.

References myId, and showLatencyTestDialogSelected().

Referenced by DtAssistantComponentMenu().

Referenced by showLatencyTestDialog().

void DtAssistantComponentMenu::showLog ( ) [virtual, slot]

Slots to handle the selection of each of the menu actions.

References myId, and showLogSelected().

Referenced by DtAssistantComponentMenu().

Whether or not the show log menu option is enabled.

References myLogAction.

Referenced by DtAssistantTrayIconMgr::processComponentUpdate().

void DtAssistantComponentMenu::showLogSelected ( int  id) [signal]

Referenced by showLog().

Returns the type of this component.

References myType.

Whether or not the web spy menu option is enabled.

References myWebSpyAction.

Referenced by DtAssistantTrayIconMgr::processComponentUpdate().


Member Data Documentation

Action to enable logging for this component.

Referenced by DtAssistantComponentMenu(), and enableShowLog().

Action to force this component to exit.

Referenced by DtAssistantComponentMenu().

Action to show the federate information.

Referenced by DtAssistantComponentMenu().

Action to open the latency test dialog for this component.

Referenced by DtAssistantComponentMenu(), enableLatencyTest(), and latencyTestEnabled().

Action to show the log of this component.

Referenced by DtAssistantComponentMenu(), enableShowLog(), and showLogEnabled().

QString DtAssistantComponentMenu::myName [protected]

The name of the component.

Referenced by DtAssistantComponentMenu(), name(), and rename().

The component type of this menu.

Referenced by DtAssistantComponentMenu(), and type().

Action to load the web spy page for this component.

Referenced by DtAssistantComponentMenu(), enableWebSpy(), and webSpyEnabled().

const unsigned DtAssistantComponentMenu::theMaxNameSize = 25 [static, protected]

The maximum length name that can be displayed.

Referenced by rename().


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)