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 Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions
DtAssistantComponentMgr Class Reference

Processes information on each local RTI component that is connected to this Assistant. More...

+ Inheritance diagram for DtAssistantComponentMgr:
+ Collaboration diagram for DtAssistantComponentMgr:

Public Slots

virtual void updateComponent (int compId, const DtAssistantComponentInfo &comp)
 Updates the component with the given ID.
- Public Slots inherited from DtAssistantMgr
void displayWarningDialogs ()
 Displays all warning dialogs.

Signals

void localFederateJoined (const DtAssistantComponentInfo *, const MAKRti::DtString &federateType, const MAKRti::DtString &federateName, unsigned federateHandle, const MAKRti::DtString &federationName, unsigned federationHandle, DtHlaVersionId hlaVersion)
 Emitted when a local federate joins a federation.
void localFederateResigned (const DtAssistantComponentInfo *)
 Emitted when a local federate resigns from a federation.
void forwarderHasRtiexec (const DtAssistantComponentInfo *)
 Emitted when a local forwarder connects with an rtiexec.
void forwarderHasNoRtiexec (const DtAssistantComponentInfo *)
 Emitted when a local forwarder disconnects with an rtiexec.
Component added signals

Emitted when a new local RTI component is added

void lrcComponentAdded (const DtAssistantComponentInfo *)
void rtiexecComponentAdded (const DtAssistantComponentInfo *)
void forwarderComponentAdded (const DtAssistantComponentInfo *)
void sharedMemComponentAdded (const DtAssistantComponentInfo *)
Component removed signals

Emitted when a local RTI component is removed

void lrcComponentRemoved (const DtAssistantComponentInfo *)
void rtiexecComponentRemoved (const DtAssistantComponentInfo *)
void forwarderComponentRemoved (const DtAssistantComponentInfo *)
void sharedMemComponentRemoved (const DtAssistantComponentInfo *)
Component removed unexpectedly signals

Emitted when a local RTI component is removed unexpectedly

void lrcComponentRemovedUnexpectedly (const DtAssistantComponentInfo *)
void rtiexecComponentRemovedUnexpectedly (const DtAssistantComponentInfo *)
void forwarderComponentRemovedUnexpectedly (const DtAssistantComponentInfo *)
void sharedMemComponentRemovedUnexpectedly (const DtAssistantComponentInfo *)
Component renamed signals

Emitted when a local RTI component is renamed

void lrcComponentRenamed (const DtAssistantComponentInfo *)
void rtiexecComponentRenamed (const DtAssistantComponentInfo *)
void forwarderComponentRenamed (const DtAssistantComponentInfo *)
void sharedMemComponentRenamed (const DtAssistantComponentInfo *)
Component connected signals

Emitted when a local RTI component disconnects its RTI connection

void lrcComponentConnected (const DtAssistantComponentInfo *)
void rtiexecComponentConnected (const DtAssistantComponentInfo *)
void forwarderComponentConnected (const DtAssistantComponentInfo *)
void lrcComponentDisconnected (const DtAssistantComponentInfo *)
void rtiexecComponentDisconnected (const DtAssistantComponentInfo *)
void forwarderComponentDisconnected (const DtAssistantComponentInfo *)
Component updated signals

Emitted when a local RTI component is updated

void lrcComponentUpdated (const DtAssistantComponentInfo *)
void rtiexecComponentUpdated (const DtAssistantComponentInfo *)
void forwarderComponentUpdated (const DtAssistantComponentInfo *)
void sharedMemComponentUpdated (const DtAssistantComponentInfo *)
- 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

 DtAssistantComponentMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
 Constructor.
virtual ~DtAssistantComponentMgr ()
 Destructor.
virtual const
DtAssistantComponentInfo
componentInfo (int compId) const
 Returns a reference to the information for the component with the given component ID.
virtual const
DtIdToComponentInfoMap
components () const
 Returns components the assistant is connected to.
virtual const
DtIdToComponentInfoMap
rtiexecComponents () const
 Returns rtiexec components the assistant is connected to.
virtual const
DtIdToComponentInfoMap
lrcComponents () const
 Returns LRC components the assistant is connected to.
virtual const
DtIdToComponentInfoMap
forwarderComponents () const
 Returns forwarder components the assistant is connected to.
virtual const
DtIdToComponentInfoMap
sharedMemComponents () const
 Returns shared memory queue components the assistant is connected to.
virtual MAKRti::DtString printLocalComponentList () const
 Print list of local components.
virtual MAKRti::DtString printFederationList (const DtAssistantExecStateMsg &msg)
 Print formatted federation info.
virtual MAKRti::DtString printRtiExecComponentsList (std::map< int, MAKRti::DtString > &data) const
 Print list of rtiExec Components.
virtual MAKRti::DtString printForwarderComponentsList (const std::map< int, MAKRti::DtString > &data) const
 Print list of Forwarder Components.
- 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 Member Functions

virtual void processSocketRemoval (int compId, const MAKRti::DtString &reason)
 Called by the callback function to process the removal of a socket.
- 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.
virtual DtAssistantInfo assistantInfoFromAssistantMsg (const DtAssistantMsg &assistantMsg, DtInetAddrSet *interfaces=0)

Static Protected Member Functions

static void processSocketRemoval (int compId, const MAKRti::DtString &reason, void *usr)
 Callback to process the removal of a socket connection.

Protected Attributes

DtClock myClock
 The clock.
DtIdToComponentInfoMap myComponentsById
 Map containing the information on all connected components indexed by component ID.
DtIdToComponentInfoMap myRtiExecComponentsById
 Map containing the information on all connected components indexed by component ID.
DtIdToComponentInfoMap myLrcComponentsById
 Map containing the information on all connected components indexed by component ID.
DtIdToComponentInfoMap myForwarderComponentsById
 Map containing the information on all connected components indexed by component ID.
DtIdToComponentInfoMap mySharedMemComponentsById
 Map containing the information on all connected components indexed by component ID.
- 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

 DtAssistantComponentMgr (DtAssistantComponentMgr const &)
 Copy Constructor not implemented – Copy Not Allowed!
DtAssistantComponentMgroperator= (DtAssistantComponentMgr const &)
 Assignment not implemented – Assignment Not Allowed!

Message Callbacks

Callbacks for component information messages

static void processConnMsg (const DtAssistantConnMsg &msg, void *usr)
 Callback to process a connection update message from a component.
static void processLrcCompInfoMsg (const DtAssistantLrcCompInfoMsg &msg, void *usr)
 Callback to process a component information message from an LRC.
static void processRtiexecCompInfoMsg (const DtAssistantRtiexecCompInfoMsg &msg, void *usr)
 Callback to process a component information message from an rtiexec.
static void processRtiForwarderCompInfoMsg (const DtAssistantRtiForwarderCompInfoMsg &msg, void *usr)
 Callback to process a component information message from an RTI Forwarder.
virtual void processConnMsg (const DtAssistantConnMsg &msg)
 Called by the callback function to process connection messages.
virtual void processNewConnMsg (const DtAssistantConnMsg &msg)
 Processes a connection message for a new connection.
virtual void processCloseConnMsg (const DtAssistantConnMsg &msg)
 Processes a connection message for a connection which is closing.
virtual void processLrcCompInfoMsg (const DtAssistantLrcCompInfoMsg &msg)
 Called by the callback function to process LRC component information messages.
virtual void processRtiexecCompInfoMsg (const DtAssistantRtiexecCompInfoMsg &msg)
 Called by the callback function to process rtiexec component information messages.
virtual void processRtiForwarderCompInfoMsg (const DtAssistantRtiForwarderCompInfoMsg &msg)
 Called by the callback function to process RTI Forwarder component information messages.

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

Processes information on each local RTI component that is connected to this Assistant.

This information is stored so that it may be retrieved by other assistant managers as needed. Emits signals to notify other classes when information has been updated.

Constructor & Destructor Documentation

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

Constructor.

virtual DtAssistantComponentMgr::~DtAssistantComponentMgr ( )
virtual

Destructor.

DtAssistantComponentMgr::DtAssistantComponentMgr ( DtAssistantComponentMgr const &  )
private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

virtual const DtAssistantComponentInfo* DtAssistantComponentMgr::componentInfo ( int  compId) const
virtual

Returns a reference to the information for the component with the given component ID.

Returns a null pointer if the component could not be found.

virtual const DtIdToComponentInfoMap& DtAssistantComponentMgr::components ( ) const
virtual

Returns components the assistant is connected to.

void DtAssistantComponentMgr::forwarderComponentAdded ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::forwarderComponentConnected ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::forwarderComponentDisconnected ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::forwarderComponentRemoved ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::forwarderComponentRemovedUnexpectedly ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::forwarderComponentRenamed ( const DtAssistantComponentInfo )
signal
virtual const DtIdToComponentInfoMap& DtAssistantComponentMgr::forwarderComponents ( ) const
virtual

Returns forwarder components the assistant is connected to.

void DtAssistantComponentMgr::forwarderComponentUpdated ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::forwarderHasNoRtiexec ( const DtAssistantComponentInfo )
signal

Emitted when a local forwarder disconnects with an rtiexec.

void DtAssistantComponentMgr::forwarderHasRtiexec ( const DtAssistantComponentInfo )
signal

Emitted when a local forwarder connects with an rtiexec.

void DtAssistantComponentMgr::localFederateJoined ( const DtAssistantComponentInfo ,
const MAKRti::DtString &  federateType,
const MAKRti::DtString &  federateName,
unsigned  federateHandle,
const MAKRti::DtString &  federationName,
unsigned  federationHandle,
DtHlaVersionId  hlaVersion 
)
signal

Emitted when a local federate joins a federation.

void DtAssistantComponentMgr::localFederateResigned ( const DtAssistantComponentInfo )
signal

Emitted when a local federate resigns from a federation.

void DtAssistantComponentMgr::lrcComponentAdded ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::lrcComponentConnected ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::lrcComponentDisconnected ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::lrcComponentRemoved ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::lrcComponentRemovedUnexpectedly ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::lrcComponentRenamed ( const DtAssistantComponentInfo )
signal
virtual const DtIdToComponentInfoMap& DtAssistantComponentMgr::lrcComponents ( ) const
virtual

Returns LRC components the assistant is connected to.

void DtAssistantComponentMgr::lrcComponentUpdated ( const DtAssistantComponentInfo )
signal
DtAssistantComponentMgr& DtAssistantComponentMgr::operator= ( DtAssistantComponentMgr const &  )
private

Assignment not implemented – Assignment Not Allowed!

virtual MAKRti::DtString DtAssistantComponentMgr::printFederationList ( const DtAssistantExecStateMsg msg)
virtual

Print formatted federation info.

virtual MAKRti::DtString DtAssistantComponentMgr::printForwarderComponentsList ( const std::map< int, MAKRti::DtString > &  data) const
virtual

Print list of Forwarder Components.

virtual MAKRti::DtString DtAssistantComponentMgr::printLocalComponentList ( ) const
virtual

Print list of local components.

virtual MAKRti::DtString DtAssistantComponentMgr::printRtiExecComponentsList ( std::map< int, MAKRti::DtString > &  data) const
virtual

Print list of rtiExec Components.

virtual void DtAssistantComponentMgr::processCloseConnMsg ( const DtAssistantConnMsg msg)
protectedvirtual

Processes a connection message for a connection which is closing.

static void DtAssistantComponentMgr::processConnMsg ( const DtAssistantConnMsg msg,
void *  usr 
)
staticprotected

Callback to process a connection update message from a component.

virtual void DtAssistantComponentMgr::processConnMsg ( const DtAssistantConnMsg msg)
protectedvirtual

Called by the callback function to process connection messages.

static void DtAssistantComponentMgr::processLrcCompInfoMsg ( const DtAssistantLrcCompInfoMsg msg,
void *  usr 
)
staticprotected

Callback to process a component information message from an LRC.

virtual void DtAssistantComponentMgr::processLrcCompInfoMsg ( const DtAssistantLrcCompInfoMsg msg)
protectedvirtual

Called by the callback function to process LRC component information messages.

virtual void DtAssistantComponentMgr::processNewConnMsg ( const DtAssistantConnMsg msg)
protectedvirtual

Processes a connection message for a new connection.

static void DtAssistantComponentMgr::processRtiexecCompInfoMsg ( const DtAssistantRtiexecCompInfoMsg msg,
void *  usr 
)
staticprotected

Callback to process a component information message from an rtiexec.

virtual void DtAssistantComponentMgr::processRtiexecCompInfoMsg ( const DtAssistantRtiexecCompInfoMsg msg)
protectedvirtual

Called by the callback function to process rtiexec component information messages.

static void DtAssistantComponentMgr::processRtiForwarderCompInfoMsg ( const DtAssistantRtiForwarderCompInfoMsg msg,
void *  usr 
)
staticprotected

Callback to process a component information message from an RTI Forwarder.

virtual void DtAssistantComponentMgr::processRtiForwarderCompInfoMsg ( const DtAssistantRtiForwarderCompInfoMsg msg)
protectedvirtual

Called by the callback function to process RTI Forwarder component information messages.

static void DtAssistantComponentMgr::processSocketRemoval ( int  compId,
const MAKRti::DtString &  reason,
void *  usr 
)
staticprotected

Callback to process the removal of a socket connection.

virtual void DtAssistantComponentMgr::processSocketRemoval ( int  compId,
const MAKRti::DtString &  reason 
)
protectedvirtual

Called by the callback function to process the removal of a socket.

void DtAssistantComponentMgr::rtiexecComponentAdded ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::rtiexecComponentConnected ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::rtiexecComponentDisconnected ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::rtiexecComponentRemoved ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::rtiexecComponentRemovedUnexpectedly ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::rtiexecComponentRenamed ( const DtAssistantComponentInfo )
signal
virtual const DtIdToComponentInfoMap& DtAssistantComponentMgr::rtiexecComponents ( ) const
virtual

Returns rtiexec components the assistant is connected to.

void DtAssistantComponentMgr::rtiexecComponentUpdated ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::sharedMemComponentAdded ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::sharedMemComponentRemoved ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::sharedMemComponentRemovedUnexpectedly ( const DtAssistantComponentInfo )
signal
void DtAssistantComponentMgr::sharedMemComponentRenamed ( const DtAssistantComponentInfo )
signal
virtual const DtIdToComponentInfoMap& DtAssistantComponentMgr::sharedMemComponents ( ) const
virtual

Returns shared memory queue components the assistant is connected to.

void DtAssistantComponentMgr::sharedMemComponentUpdated ( const DtAssistantComponentInfo )
signal
virtual void DtAssistantComponentMgr::updateComponent ( int  compId,
const DtAssistantComponentInfo comp 
)
virtualslot

Updates the component with the given ID.

Member Data Documentation

DtClock DtAssistantComponentMgr::myClock
protected

The clock.

DtIdToComponentInfoMap DtAssistantComponentMgr::myComponentsById
protected

Map containing the information on all connected components indexed by component ID.

DtIdToComponentInfoMap DtAssistantComponentMgr::myForwarderComponentsById
protected

Map containing the information on all connected components indexed by component ID.

DtIdToComponentInfoMap DtAssistantComponentMgr::myLrcComponentsById
protected

Map containing the information on all connected components indexed by component ID.

DtIdToComponentInfoMap DtAssistantComponentMgr::myRtiExecComponentsById
protected

Map containing the information on all connected components indexed by component ID.

DtIdToComponentInfoMap DtAssistantComponentMgr::mySharedMemComponentsById
protected

Map containing the information on all connected components indexed by component ID.


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

Document ID: Generated on Mon Jul 9 10:30:41 EDT 2018 from SVN revision 190224
Copyright © 2005-2018 VT MÄK Inc. All Rights Reserved (www.mak.com)