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 | Public Slots | Public Member Functions | Protected Attributes | Private Member Functions
DtAssistantPreferencesInfoMgr Class Reference

Manages the current assistant preferences and displays the preferences dialog when required. More...

+ Inheritance diagram for DtAssistantPreferencesInfoMgr:
+ Collaboration diagram for DtAssistantPreferencesInfoMgr:

Public Slots

void savePreferences ()
 Saves the current preferences to file. More...
 
void setLogUpdateInterval (unsigned int)
 Slots for updating configuration parameters. More...
 
void setKeepAlive (bool)
 Slots for updating configuration parameters. More...
 
void setSendForeignQuery (bool)
 Slots for updating configuration parameters. More...
 
void setLatencyTestInteractionPeriodMs (unsigned int)
 Slots for updating configuration parameters. More...
 
void setLatencyTestNumInteractions (unsigned int)
 Slots for updating configuration parameters. More...
 
void setLatencyTestPayloadBytes (unsigned int)
 Slots for updating configuration parameters. More...
 
void setDisplayPopupsAsNotifications (bool)
 Slots for updating configuration parameters. More...
 
void setEnableNotifications (bool)
 Slots for updating configuration parameters. More...
 
void setLightweightMemorySec (unsigned int)
 Slots for updating configuration parameters. More...
 
void setDefunctFederateRemovalTimeSec (float)
 Slots for updating configuration parameters. More...
 
void setAssistantUpdateIntervalSec (unsigned int)
 Slots for updating configuration parameters. More...
 
void setLrcNetStatsUpdateIntervalSec (unsigned int)
 Slots for updating configuration parameters. More...
 
void setShowRtiexecStartupPrompt (bool)
 Slots for updating configuration parameters. More...
 
void setAcceptRemoteCommands (bool)
 Slots for updating configuration parameters. More...
 
void setAssistantPersistent (bool)
 Slots for updating configuration parameters. More...
 
void setDefaultToUnlicensed (bool)
 Slots for updating configuration parameters. More...
 
void setWarningTickInterval (float)
 Slots for updating configuration parameters. More...
 
void setDisplayRemoteNotifications (bool)
 Slots for updating configuration parameters. More...
 
void setDisplayFederationColors (bool)
 Slots for updating configuration parameters. More...
 
void setFederateIdentifier (unsigned int)
 Slots for updating configuration parameters. More...
 
- Public Slots inherited from DtAssistantMgr
void displayWarningDialogs ()
 Displays all warning dialogs. More...
 

Signals

void logUpdateIntervalUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void keepAliveUpdated (bool)
 Signals for configuration parameter updates. More...
 
void sendForeignQueryUpdated (bool)
 Signals for configuration parameter updates. More...
 
void latencyTestInteractionPeriodMsUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void latencyTestNumInteractionsUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void latencyTestPayloadBytesUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void displayPopupsAsNotificationsUpdated (bool)
 Signals for configuration parameter updates. More...
 
void enableNotificationsUpdated (bool)
 Signals for configuration parameter updates. More...
 
void lightweightMemorySecUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void defunctFederateRemovalTimeSecUpdated (float)
 Signals for configuration parameter updates. More...
 
void assistantUpdateIntervalSecUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void lrcNetStatsUpdateIntervalSecUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
void showRtiexecStartupPromptUpdated (bool)
 Signals for configuration parameter updates. More...
 
void acceptRemoteCommandsUpdated (bool)
 Signals for configuration parameter updates. More...
 
void assistantPersistentUpdated (bool)
 Signals for configuration parameter updates. More...
 
void defaultToUnlicensedUpdated (bool)
 Signals for configuration parameter updates. More...
 
void warningTickIntervalUpdated (float)
 Signals for configuration parameter updates. More...
 
void displayRemoteNotificationsUpdated (bool)
 Signals for configuration parameter updates. More...
 
void displayFederationColorsUpdated (bool)
 Signals for configuration parameter updates. More...
 
void federateIdentifierUpdated (unsigned int)
 Signals for configuration parameter updates. More...
 
- Signals inherited from DtAssistantMgr
void warningDialogDisplayed ()
 Emitted when a warning dialog is displayed. More...
 
void warningDialogDismissed ()
 Emitted when a warning dialog is dismissed. More...
 
void popupRequested (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
 Emitted when a popup dialog should be displayed. More...
 
void popupRequested (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
 Emitted when a popup dialog should be displayed. More...
 
void notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId, bool logOnly)
 Emitted when a notification should be displayed. More...
 
void notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source, bool logOnly)
 Emitted when a notification should be displayed. More...
 

Public Member Functions

 DtAssistantPreferencesInfoMgr (std::shared_ptr< DtRtiAssistantServer > server, std::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, const MAKRti::DtFilename &configDir)
 Constructor. More...
 
virtual ~DtAssistantPreferencesInfoMgr ()
 Destructor. More...
 
virtual void initialize ()
 Initializes this manager just prior to beginning assistant processing. More...
 
virtual void startShutdown ()
 Performs any necessary processing at the start of shutdown. More...
 
virtual bool isConfigFileVersionOld () const
 Returns true if the opened config file had an older version. More...
 
virtual unsigned int logUpdateInterval () const
 Accessors for configuration parameters. More...
 
virtual bool keepAlive () const
 Accessors for configuration parameters. More...
 
virtual bool sendForeignQuery () const
 Accessors for configuration parameters. More...
 
virtual unsigned int latencyTestInteractionPeriodMs () const
 Accessors for configuration parameters. More...
 
virtual unsigned int latencyTestNumInteractions () const
 Accessors for configuration parameters. More...
 
virtual unsigned int latencyTestPayloadBytes () const
 Accessors for configuration parameters. More...
 
virtual bool displayPopupsAsNotifications () const
 Accessors for configuration parameters. More...
 
virtual bool enableNotifications () const
 Accessors for configuration parameters. More...
 
virtual unsigned int lightweightMemorySec () const
 Accessors for configuration parameters. More...
 
virtual float defunctFederateRemovalTimeSec () const
 Accessors for configuration parameters. More...
 
virtual unsigned int assistantUpdateIntervalSec () const
 Accessors for configuration parameters. More...
 
virtual unsigned int lrcNetStatsUpdateIntervalSec () const
 Accessors for configuration parameters. More...
 
virtual bool showRtiexecStartupPrompt () const
 Accessors for configuration parameters. More...
 
virtual bool acceptRemoteCommands () const
 Accessors for configuration parameters. More...
 
virtual bool assistantPersistent () const
 Accessors for configuration parameters. More...
 
virtual bool defaultToUnlicensed () const
 Accessors for configuration parameters. More...
 
virtual float warningTickInterval () const
 Accessors for configuration parameters. More...
 
virtual bool displayRemoteNotifications () const
 Accessors for configuration parameters. More...
 
virtual bool displayFederationColors () const
 Accessors for configuration parameters. More...
 
virtual unsigned int federateIdentifier () const
 Accessors for configuration parameters. More...
 
- Public Member Functions inherited from DtAssistantMgr
 DtAssistantMgr (std::shared_ptr< DtRtiAssistantServer > server, std::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
 Constructor. More...
 
virtual ~DtAssistantMgr ()
 Destructor. More...
 
virtual void tick ()
 Performs tasks that need to be completed periodically. More...
 
virtual bool dialogsVisible () const
 Determines if there are any visible dialogs for which this manager is responsible. More...
 
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. More...
 
virtual void updateConfigWidget ()
 Forces the configuration widget to be updated. More...
 
virtual void processConfigWidgetAccept ()
 Process the changes that were accepted in the configuration widget. More...
 

Protected Attributes

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

Private Member Functions

 DtAssistantPreferencesInfoMgr (DtAssistantPreferencesInfoMgr const &)
 Copy Constructor not implemented – Copy Not Allowed! More...
 
DtAssistantPreferencesInfoMgroperator= (DtAssistantPreferencesInfoMgr const &)
 Assignment not implemented – Assignment Not Allowed! More...
 

Additional Inherited Members

- Protected Member Functions inherited from DtAssistantMgr
void startDialog (QDialog *dlg, bool inTaskbar, bool warningDialog)
 Sets up the given widget as a dialog. More...
 
void finishDialog (QDialog *dlg)
 Should be called prior to deleting any dialog started with startDialog. More...
 
void showDialog (QDialog *dlg)
 Shows the dialog. More...
 
void startMainWindow (QMainWindow *dlg)
 Sets up a main window dialog. More...
 
void finishMainWindow (QMainWindow *dlg)
 Should be called prior to deleting any dialog started with startMainWindow. More...
 
void showMainWindow (QMainWindow *dlg)
 Shows the dialog. More...
 
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. More...
 
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. More...
 
void displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
 Displays and logs a notification from the given component. More...
 
void displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
 Displays and logs notification with the given component name. More...
 
void logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
 Logs a notification from the given component, does not display. More...
 
void logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
 Logs a notification with the given component name, does not display. More...
 
virtual DtAssistantInfo assistantInfoFromAssistantMsg (const DtAssistantMsg &assistantMsg, DtInetAddrSet *interfaces=0)
 
- Static Protected Attributes inherited from DtAssistantMgr
static QIcon theRtiIcon
 The icons used by the RTI Assistant. More...
 
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. More...
 

Detailed Description

Manages the current assistant preferences and displays the preferences dialog when required.

Constructor & Destructor Documentation

DtAssistantPreferencesInfoMgr::DtAssistantPreferencesInfoMgr ( std::shared_ptr< DtRtiAssistantServer server,
std::shared_ptr< DtRtiAssistantPeer peer,
DtAssistantSignalRouter signalRouter,
const MAKRti::DtFilename &  configDir 
)

Constructor.

virtual DtAssistantPreferencesInfoMgr::~DtAssistantPreferencesInfoMgr ( )
virtual

Destructor.

DtAssistantPreferencesInfoMgr::DtAssistantPreferencesInfoMgr ( DtAssistantPreferencesInfoMgr const &  )
private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

virtual bool DtAssistantPreferencesInfoMgr::acceptRemoteCommands ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::acceptRemoteCommandsUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual bool DtAssistantPreferencesInfoMgr::assistantPersistent ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::assistantPersistentUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::assistantUpdateIntervalSec ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::assistantUpdateIntervalSecUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual bool DtAssistantPreferencesInfoMgr::defaultToUnlicensed ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::defaultToUnlicensedUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual float DtAssistantPreferencesInfoMgr::defunctFederateRemovalTimeSec ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::defunctFederateRemovalTimeSecUpdated ( float  )
signal

Signals for configuration parameter updates.

virtual bool DtAssistantPreferencesInfoMgr::displayFederationColors ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::displayFederationColorsUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual bool DtAssistantPreferencesInfoMgr::displayPopupsAsNotifications ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::displayPopupsAsNotificationsUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual bool DtAssistantPreferencesInfoMgr::displayRemoteNotifications ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::displayRemoteNotificationsUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual bool DtAssistantPreferencesInfoMgr::enableNotifications ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::enableNotificationsUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::federateIdentifier ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::federateIdentifierUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual void DtAssistantPreferencesInfoMgr::initialize ( )
virtual

Initializes this manager just prior to beginning assistant processing.

Reimplemented from DtAssistantMgr.

virtual bool DtAssistantPreferencesInfoMgr::isConfigFileVersionOld ( ) const
virtual

Returns true if the opened config file had an older version.

virtual bool DtAssistantPreferencesInfoMgr::keepAlive ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::keepAliveUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::latencyTestInteractionPeriodMs ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::latencyTestInteractionPeriodMsUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::latencyTestNumInteractions ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::latencyTestNumInteractionsUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::latencyTestPayloadBytes ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::latencyTestPayloadBytesUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::lightweightMemorySec ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::lightweightMemorySecUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::logUpdateInterval ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::logUpdateIntervalUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

virtual unsigned int DtAssistantPreferencesInfoMgr::lrcNetStatsUpdateIntervalSec ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::lrcNetStatsUpdateIntervalSecUpdated ( unsigned  int)
signal

Signals for configuration parameter updates.

DtAssistantPreferencesInfoMgr& DtAssistantPreferencesInfoMgr::operator= ( DtAssistantPreferencesInfoMgr const &  )
private

Assignment not implemented – Assignment Not Allowed!

void DtAssistantPreferencesInfoMgr::savePreferences ( )
slot

Saves the current preferences to file.

virtual bool DtAssistantPreferencesInfoMgr::sendForeignQuery ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::sendForeignQueryUpdated ( bool  )
signal

Signals for configuration parameter updates.

void DtAssistantPreferencesInfoMgr::setAcceptRemoteCommands ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setAssistantPersistent ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setAssistantUpdateIntervalSec ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setDefaultToUnlicensed ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setDefunctFederateRemovalTimeSec ( float  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setDisplayFederationColors ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setDisplayPopupsAsNotifications ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setDisplayRemoteNotifications ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setEnableNotifications ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setFederateIdentifier ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setKeepAlive ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setLatencyTestInteractionPeriodMs ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setLatencyTestNumInteractions ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setLatencyTestPayloadBytes ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setLightweightMemorySec ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setLogUpdateInterval ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setLrcNetStatsUpdateIntervalSec ( unsigned  int)
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setSendForeignQuery ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setShowRtiexecStartupPrompt ( bool  )
slot

Slots for updating configuration parameters.

void DtAssistantPreferencesInfoMgr::setWarningTickInterval ( float  )
slot

Slots for updating configuration parameters.

virtual bool DtAssistantPreferencesInfoMgr::showRtiexecStartupPrompt ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::showRtiexecStartupPromptUpdated ( bool  )
signal

Signals for configuration parameter updates.

virtual void DtAssistantPreferencesInfoMgr::startShutdown ( )
virtual

Performs any necessary processing at the start of shutdown.

Reimplemented from DtAssistantMgr.

virtual float DtAssistantPreferencesInfoMgr::warningTickInterval ( ) const
virtual

Accessors for configuration parameters.

void DtAssistantPreferencesInfoMgr::warningTickIntervalUpdated ( float  )
signal

Signals for configuration parameter updates.

Member Data Documentation

std::shared_ptr<DtAssistantConfig> DtAssistantPreferencesInfoMgr::myConfig
protected

The current Assistant configuration.


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

Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)