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 | Signals | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
DtAssistantLicenseQueryMgr Class Reference

Maintains list of known RTI license servers and processes license queries from RTI components. More...

+ Inheritance diagram for DtAssistantLicenseQueryMgr:
+ Collaboration diagram for DtAssistantLicenseQueryMgr:

Public Slots

void processLicQueryResults (int result)
 Processes the results of a license query dialog. More...
 
void closeLicQueryDialogForId (const DtAssistantComponentInfo *)
 Closes the license query dialog if it is for the component with the matching ID. More...
 
void addLicenseServerFromComponent (const DtAssistantComponentInfo *)
 Adds a new license server (or servers if string contains multiple) to the list. More...
 
void removeLicenseServer (const MAKRti::DtString &server)
 Removes a license server from the list. More...
 
void sendLicenseServerUpdate ()
 Sends a license server update message. More...
 
void clearStoredLicense ()
 Clears the stored license. More...
 
void setDefaultToUnlicensed (bool)
 Processes a change in whether or not we are defaulting to unlicensed. More...
 
void updateFromCache ()
 Updates the dialog from the stored license. More...
 
- Public Slots inherited from DtAssistantMgr
void displayWarningDialogs ()
 Displays all warning dialogs. More...
 

Signals

void chosenLicServerUpdated (const QString &name, int port)
 Emitted when the chosen license server changes. More...
 
void unlicensedModeChosen (bool)
 Emitted when unlicensed mode is chosen or unchosen. More...
 
void updateDefaultToUnlicensed (bool)
 Emitted when updating whether or not we are defaulting to unlicensed mode. 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

 DtAssistantLicenseQueryMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, DtBoost::shared_ptr< DtAssistantComponentMgr > compMgr)
 Constructor. More...
 
virtual ~DtAssistantLicenseQueryMgr ()
 Destructor. More...
 
virtual void tick ()
 Performs tasks that need to be completed periodically. 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...
 
- Public Member Functions inherited from DtAssistantMgr
 DtAssistantMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
 Constructor. More...
 
virtual ~DtAssistantMgr ()
 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 dialogsVisible () const
 Determines if there are any visible dialogs for which this manager is responsible. More...
 
virtual void processConfigWidgetAccept ()
 Process the changes that were accepted in the configuration widget. More...
 

Protected Types

enum  DtLicenseChosenState { NothingChosen, UnlicensedChosen, LicenseChosen }
 

Protected Member Functions

virtual void updateLicQuery ()
 Updates the list of available license servers. More...
 
- 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)
 

Protected Attributes

DtAssistantMsgQueue myLicQueryMsgQueue
 The queue which holds license query messages. More...
 
DtBoost::shared_ptr
< DtAssistantComponentMgr
myCompMgr
 The manager that keeps track of all local RTI components. More...
 
DtAssistantLicQueryDialogmyLicQueryDlg
 The dialog which queries the user for license information. More...
 
DtAssistantLicServerConfigWidgetmyLicConfigWidget
 The widget that displays the current preferred license in the configuration dialog. More...
 
DtLicenseChosenState myLicenseChosenState
 Whether a license is chosen, unlicensed mode is chosen, or nothing is chosen. More...
 
DtLicServerInfo myChosenLicenseServer
 The currently chosen license server. More...
 
DtLicServerSet myLicenseServers
 Set of license servers known to this assistant. More...
 
DtLicServerSet myRemovedLicenseServers
 Set of removed local license servers since last update was sent. More...
 
std::set< int > myCompsWithLicServers
 The set of components we've received license servers from. More...
 
- Protected Attributes inherited from DtAssistantMgr
DtBoost::shared_ptr
< DtRtiAssistantServer
myServer
 The Assistant server from which new messages will arrive from local RTI components. More...
 
DtBoost::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

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

Message Callbacks

Callbacks for license messages

static void addLicQueryMsgToQueue (const DtAssistantLicQueryMsg &msg, void *usr)
 Callback to add license query message to queue. More...
 
static void processLicQueryMsg (const DtAssistantLicQueryMsg &msg, void *usr)
 Callback to process a license query message from a component. More...
 
static void processLicServerInfoMsg (const DtAssistantLicServerInfoMsg &msg, void *usr)
 Called to process a change in the available license servers. More...
 
virtual void addLicQueryMsgToQueue (const DtAssistantLicQueryMsg &msg)
 Called by the callback function to add a message to the queue. More...
 
virtual void processLicQueryMsg (const DtAssistantLicQueryMsg &msg)
 Called by the callback function to process license query messages. More...
 
virtual void processLicServerInfoMsg (const DtAssistantLicServerInfoMsg &msg)
 Called by the callback function to process the a change in the available license servers. More...
 

Additional Inherited Members

- 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

Maintains list of known RTI license servers and processes license queries from RTI components.

Member Enumeration Documentation

Enumerator
NothingChosen 
UnlicensedChosen 
LicenseChosen 

Constructor & Destructor Documentation

DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr ( DtBoost::shared_ptr< DtRtiAssistantServer server,
DtBoost::shared_ptr< DtRtiAssistantPeer peer,
DtAssistantSignalRouter signalRouter,
DtBoost::shared_ptr< DtAssistantComponentMgr compMgr 
)

Constructor.

virtual DtAssistantLicenseQueryMgr::~DtAssistantLicenseQueryMgr ( )
virtual

Destructor.

DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr ( DtAssistantLicenseQueryMgr const &  )
private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

void DtAssistantLicenseQueryMgr::addLicenseServerFromComponent ( const DtAssistantComponentInfo )
slot

Adds a new license server (or servers if string contains multiple) to the list.

static void DtAssistantLicenseQueryMgr::addLicQueryMsgToQueue ( const DtAssistantLicQueryMsg msg,
void *  usr 
)
staticprotected

Callback to add license query message to queue.

License query messages should be added to a queue in order to be processed one at a time. Two license query dialogs should not be displayed at the same time.

virtual void DtAssistantLicenseQueryMgr::addLicQueryMsgToQueue ( const DtAssistantLicQueryMsg msg)
protectedvirtual

Called by the callback function to add a message to the queue.

void DtAssistantLicenseQueryMgr::chosenLicServerUpdated ( const QString &  name,
int  port 
)
signal

Emitted when the chosen license server changes.

void DtAssistantLicenseQueryMgr::clearStoredLicense ( )
slot

Clears the stored license.

void DtAssistantLicenseQueryMgr::closeLicQueryDialogForId ( const DtAssistantComponentInfo )
slot

Closes the license query dialog if it is for the component with the matching ID.

virtual void DtAssistantLicenseQueryMgr::configWidget ( DtAssistantConfigWidget **  widget,
QIcon &  icon,
QString &  name,
DtPreferencesPage pageId 
)
virtual

Retrieves a widget which will be placed in the configuration dialog for configuring user preferences.

Reimplemented from DtAssistantMgr.

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

Assignment not implemented – Assignment Not Allowed!

static void DtAssistantLicenseQueryMgr::processLicQueryMsg ( const DtAssistantLicQueryMsg msg,
void *  usr 
)
staticprotected

Callback to process a license query message from a component.

virtual void DtAssistantLicenseQueryMgr::processLicQueryMsg ( const DtAssistantLicQueryMsg msg)
protectedvirtual

Called by the callback function to process license query messages.

void DtAssistantLicenseQueryMgr::processLicQueryResults ( int  result)
slot

Processes the results of a license query dialog.

static void DtAssistantLicenseQueryMgr::processLicServerInfoMsg ( const DtAssistantLicServerInfoMsg msg,
void *  usr 
)
staticprotected

Called to process a change in the available license servers.

virtual void DtAssistantLicenseQueryMgr::processLicServerInfoMsg ( const DtAssistantLicServerInfoMsg msg)
protectedvirtual

Called by the callback function to process the a change in the available license servers.

void DtAssistantLicenseQueryMgr::removeLicenseServer ( const MAKRti::DtString &  server)
slot

Removes a license server from the list.

void DtAssistantLicenseQueryMgr::sendLicenseServerUpdate ( )
slot

Sends a license server update message.

void DtAssistantLicenseQueryMgr::setDefaultToUnlicensed ( bool  )
slot

Processes a change in whether or not we are defaulting to unlicensed.

virtual void DtAssistantLicenseQueryMgr::tick ( )
virtual

Performs tasks that need to be completed periodically.

Reimplemented from DtAssistantMgr.

void DtAssistantLicenseQueryMgr::unlicensedModeChosen ( bool  )
signal

Emitted when unlicensed mode is chosen or unchosen.

virtual void DtAssistantLicenseQueryMgr::updateConfigWidget ( )
virtual

Forces the configuration widget to be updated.

Reimplemented from DtAssistantMgr.

void DtAssistantLicenseQueryMgr::updateDefaultToUnlicensed ( bool  )
signal

Emitted when updating whether or not we are defaulting to unlicensed mode.

void DtAssistantLicenseQueryMgr::updateFromCache ( )
slot

Updates the dialog from the stored license.

virtual void DtAssistantLicenseQueryMgr::updateLicQuery ( )
protectedvirtual

Updates the list of available license servers.

Member Data Documentation

DtLicServerInfo DtAssistantLicenseQueryMgr::myChosenLicenseServer
protected

The currently chosen license server.

DtBoost::shared_ptr<DtAssistantComponentMgr> DtAssistantLicenseQueryMgr::myCompMgr
protected

The manager that keeps track of all local RTI components.

std::set<int> DtAssistantLicenseQueryMgr::myCompsWithLicServers
protected

The set of components we've received license servers from.

DtAssistantLicServerConfigWidget* DtAssistantLicenseQueryMgr::myLicConfigWidget
protected

The widget that displays the current preferred license in the configuration dialog.

DtLicenseChosenState DtAssistantLicenseQueryMgr::myLicenseChosenState
protected

Whether a license is chosen, unlicensed mode is chosen, or nothing is chosen.

DtLicServerSet DtAssistantLicenseQueryMgr::myLicenseServers
protected

Set of license servers known to this assistant.

DtAssistantLicQueryDialog* DtAssistantLicenseQueryMgr::myLicQueryDlg
protected

The dialog which queries the user for license information.

DtAssistantMsgQueue DtAssistantLicenseQueryMgr::myLicQueryMsgQueue
protected

The queue which holds license query messages.

Only one may be processed at a time, but this should not prevent the processing of other messages.

DtLicServerSet DtAssistantLicenseQueryMgr::myRemovedLicenseServers
protected

Set of removed local license servers since last update was sent.


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

Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)