MAK RTIspy API Documentation for HLA Evolved
 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 | Static Protected Attributes | Private Member Functions
DtAssistantForwarderCompInfoMgr Class Reference

Compiles network component information from RTI Forwarders. More...

+ Inheritance diagram for DtAssistantForwarderCompInfoMgr:
+ Collaboration diagram for DtAssistantForwarderCompInfoMgr:

Public Slots

void processConnectionsUpdate (const DtRtiConnectionAndConfiguration &conns)
 Processes changes in connection state. More...
 
void processConnectionsRemoval (const DtRtiConnectionAndConfiguration &conns)
 Processes removal of known connections. More...
 
void sendAllForwarderInfo ()
 Sends udpate message for all local conns to remote assistants. More...
 
void sendObserveForwarderMsgToPeer (bool shouldObserve=true)
 This Assistant is viewing or stopped viewing a remote forwarder. More...
 
void sendObserveForwarderMsgForViewedPeers (bool shouldObserve=true)
 Sends a message to the peers of the current connection that they are being observed by this assistant. More...
 
void federateRemovalTimeChanged (float val)
 Handle a change in the defunct federation removal time. More...
 
void provideForwarderInfo (const DtRtiConnectionInfo &conn, const DtAssistantForwarderInfo **info)
 Response to a query for forwarder info. More...
 
void providePeerForwarderInfo (const DtRtiConnectionInfo &, std::vector< DtAssistantForwarderInfo > *)
 Response to a query for peer forwarder info. More...
 
- Public Slots inherited from DtAssistantMgr
void displayWarningDialogs ()
 Displays all warning dialogs. More...
 

Signals

void forwarderAdded (const DtRtiConnectionInfo &conn)
 Emitted when a new forwarder is discovered. More...
 
void forwarderConnUpdated (const DtRtiConnectionInfo &conn)
 Emitted when the connection info of a known forwarder is updated. More...
 
void forwarderUpdated (const DtRtiConnectionInfo &conn)
 Emitted when a known forwarder is updated. More...
 
void forwarderRemoved (const DtRtiConnectionInfo &conn)
 Emitted when a known forwarder is removed. 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

 DtAssistantForwarderCompInfoMgr (std::shared_ptr< DtRtiAssistantServer > server, std::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, std::shared_ptr< DtAssistantComponentMgr > compMgr, std::shared_ptr< DtAssistantConnectionInfoMgr > connInfoMgr)
 Constructor. More...
 
 ~DtAssistantForwarderCompInfoMgr ()
 Destructor. More...
 
virtual void tick ()
 Performs tasks that need to be completed periodically. More...
 
virtual bool isLocalForwarder (const DtRtiConnectionInfo &conn) const
 Returns true if the given forwarder connection is for an active local forwarder. More...
 
virtual bool isRemoteForwarder (const DtRtiConnectionInfo &conn) const
 Returns true if the given forwarder connection is for an active remote forwarder. More...
 
virtual void requestSingleUpdateFromConnectedForwarders (int id)
 Performs a single data request of the connected RTI Forwarders. More...
 
virtual void viewNetworkComponentsForConnection (const DtRtiConnectionInfo &conn)
 Sets the connection which is currently being viewed. More...
 
virtual const
DtAssistantForwarderInfo
forwarderInfo (const DtRtiConnectionInfo &conn) const
 Gets the stored information for the given forwarder. More...
 
const std::set< const
DtAssistantForwarderInfo * > 
peerForwarderInfos (const DtRtiConnectionInfo &conn) const
 Gets the stored information for the given forwarder's peer forwarders. More...
 
virtual std::pair
< DtRtiConnectionInfo, bool > 
forwarderConnectionInfo (const DtAssistantNetworkCompInfo &conn) const
 Searches for Connection info and locality for a forwarder component (used to find peer forwarder connections) More...
 
virtual bool isObservedPeerOfViewedConnection (const DtRtiConnectionInfo &conn) const
 Returns whether given connection is an observed peer of viewed connection. More...
 
virtual void updateObservedPeers (const DtRtiConnectionInfo &conn, bool addOrRemove)
 Update set of stored observed rtiForwarder connections. More...
 
virtual int getPeerForwarders (const DtRtiConnectionInfo &conn, std::set< DtRtiConnectionInfo > &peers) const
 Get the set of peer forwarders Return number of connections in set. More...
 
virtual bool isPeerForwarder (const DtRtiConnectionInfo &conn, const DtRtiConnectionInfo &peerConn) const
 Return true if the given connections are peers within a network of forwarders. 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 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 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 Types

typedef std::map
< DtRtiConnectionInfo,
DtAssistantInfoSet
DtConnectionToObserversMap
 
typedef std::map
< DtRtiConnectionInfo,
DtAssistantForwarderInfo
DtForwarderStateByConnectionMap
 

Protected Member Functions

virtual void pruneTimedOutSingleUpdates ()
 If there were RTI Forwarder updates that timed out, we send back the incomplete msg. 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

std::shared_ptr
< DtAssistantComponentMgr
myCompMgr
 The local RTI component manager. More...
 
std::shared_ptr
< DtAssistantConnectionInfoMgr
myConnInfoMgr
 The connection info manager. More...
 
DtRtiConnectionInfo myViewedRtiForwarder
 The forwarder connection currently being viewed at this Assistant. More...
 
DtConnectionToObserversMap myRemotelyViewedRtiForwarders
 Local forwarder connections currently being viewed by remote Assistants, and the set of all Assistants which are viewing them. More...
 
DtForwarderStateByConnectionMap myRemoteForwarders
 information on all known remote forwarders. More...
 
DtForwarderStateByConnectionMap myLocalForwarders
 information on all local forwarders. More...
 
MAKRti::DtClock myClock
 Clock used to determine if we need to resend lost messages. More...
 
unsigned int myTimeStateUpdateInterval
 The interval, in ms, at which local rtiForwarders should be requested to send updated time state information from local rtiForwarders. More...
 
float myDefunctRemovalTime
 Defunct removal time for dropped federates. More...
 
std::map< std::pair< int,
MAKRti::DtTime >, std::map
< int, MAKRti::DtString > > 
myRequestedRtiForwarderUpdates
 
std::set< DtRtiConnectionInfomyObservedPeerRtiForwarderSet
 
- 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...
 

Static Protected Attributes

static const int theTimeToWaitForForwarderInfo
 The time, in seconds, to wait for information from the remotely viewed RTI Forwarder before resending the observation request. More...
 
- 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...
 

Private Member Functions

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

Message Callbacks

Callbacks for federation information messages

virtual void processForwarderObserveMsg (const DtAssistantStateObserveMsg &msg)
 Called by the callback function to process a forwarder state message. More...
 
virtual void processForwarderStateMsgForConnection (const DtAssistantForwarderStateMsg &msg)
 Called by the callback function to process a federation state message on behalf of an rtiAssistanttoAssistantClient that requested the data. More...
 
virtual void handleRtiCommands (const DtAssistantForwarderStateMsg &msg)
 Called by the callback function to process a forwarder state message. More...
 
virtual void processAssistantCommandMsg (const DtAssistantCommandMsg &msg)
 Processes an RTI Assistant command message. More...
 
static void processForwarderObserveMsg (const DtAssistantStateObserveMsg &msg, void *usr)
 Callback to process a forwarder state message. More...
 
static void processForwarderStateMsgForConnection (const DtAssistantForwarderStateMsg &msg, void *usr)
 Called to process a forwarder state message on behalf of an rtiAssistanttoAssistantClient that requested the data. More...
 
static void processAssistantCommandMsg (const DtAssistantCommandMsg &msg, void *usr)
 Processes an RTI Assistant command message. More...
 

Detailed Description

Compiles network component information from RTI Forwarders.

Member Typedef Documentation

Constructor & Destructor Documentation

DtAssistantForwarderCompInfoMgr::DtAssistantForwarderCompInfoMgr ( std::shared_ptr< DtRtiAssistantServer server,
std::shared_ptr< DtRtiAssistantPeer peer,
DtAssistantSignalRouter signalRouter,
std::shared_ptr< DtAssistantComponentMgr compMgr,
std::shared_ptr< DtAssistantConnectionInfoMgr connInfoMgr 
)

Constructor.

DtAssistantForwarderCompInfoMgr::~DtAssistantForwarderCompInfoMgr ( )

Destructor.

DtAssistantForwarderCompInfoMgr::DtAssistantForwarderCompInfoMgr ( DtAssistantForwarderCompInfoMgr const &  )
private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

void DtAssistantForwarderCompInfoMgr::federateRemovalTimeChanged ( float  val)
slot

Handle a change in the defunct federation removal time.

void DtAssistantForwarderCompInfoMgr::forwarderAdded ( const DtRtiConnectionInfo conn)
signal

Emitted when a new forwarder is discovered.

virtual std::pair<DtRtiConnectionInfo, bool> DtAssistantForwarderCompInfoMgr::forwarderConnectionInfo ( const DtAssistantNetworkCompInfo conn) const
virtual

Searches for Connection info and locality for a forwarder component (used to find peer forwarder connections)

void DtAssistantForwarderCompInfoMgr::forwarderConnUpdated ( const DtRtiConnectionInfo conn)
signal

Emitted when the connection info of a known forwarder is updated.

virtual const DtAssistantForwarderInfo* DtAssistantForwarderCompInfoMgr::forwarderInfo ( const DtRtiConnectionInfo conn) const
virtual

Gets the stored information for the given forwarder.

void DtAssistantForwarderCompInfoMgr::forwarderRemoved ( const DtRtiConnectionInfo conn)
signal

Emitted when a known forwarder is removed.

void DtAssistantForwarderCompInfoMgr::forwarderUpdated ( const DtRtiConnectionInfo conn)
signal

Emitted when a known forwarder is updated.

virtual int DtAssistantForwarderCompInfoMgr::getPeerForwarders ( const DtRtiConnectionInfo conn,
std::set< DtRtiConnectionInfo > &  peers 
) const
virtual

Get the set of peer forwarders Return number of connections in set.

virtual void DtAssistantForwarderCompInfoMgr::handleRtiCommands ( const DtAssistantForwarderStateMsg msg)
virtual

Called by the callback function to process a forwarder state message.

virtual bool DtAssistantForwarderCompInfoMgr::isLocalForwarder ( const DtRtiConnectionInfo conn) const
virtual

Returns true if the given forwarder connection is for an active local forwarder.

virtual bool DtAssistantForwarderCompInfoMgr::isObservedPeerOfViewedConnection ( const DtRtiConnectionInfo conn) const
virtual

Returns whether given connection is an observed peer of viewed connection.

virtual bool DtAssistantForwarderCompInfoMgr::isPeerForwarder ( const DtRtiConnectionInfo conn,
const DtRtiConnectionInfo peerConn 
) const
virtual

Return true if the given connections are peers within a network of forwarders.

virtual bool DtAssistantForwarderCompInfoMgr::isRemoteForwarder ( const DtRtiConnectionInfo conn) const
virtual

Returns true if the given forwarder connection is for an active remote forwarder.

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

Assignment not implemented – Assignment Not Allowed!

const std::set<const DtAssistantForwarderInfo*> DtAssistantForwarderCompInfoMgr::peerForwarderInfos ( const DtRtiConnectionInfo conn) const

Gets the stored information for the given forwarder's peer forwarders.

static void DtAssistantForwarderCompInfoMgr::processAssistantCommandMsg ( const DtAssistantCommandMsg msg,
void *  usr 
)
static

Processes an RTI Assistant command message.

virtual void DtAssistantForwarderCompInfoMgr::processAssistantCommandMsg ( const DtAssistantCommandMsg msg)
virtual

Processes an RTI Assistant command message.

void DtAssistantForwarderCompInfoMgr::processConnectionsRemoval ( const DtRtiConnectionAndConfiguration conns)
slot

Processes removal of known connections.

void DtAssistantForwarderCompInfoMgr::processConnectionsUpdate ( const DtRtiConnectionAndConfiguration conns)
slot

Processes changes in connection state.

static void DtAssistantForwarderCompInfoMgr::processForwarderObserveMsg ( const DtAssistantStateObserveMsg msg,
void *  usr 
)
static

Callback to process a forwarder state message.

virtual void DtAssistantForwarderCompInfoMgr::processForwarderObserveMsg ( const DtAssistantStateObserveMsg msg)
virtual

Called by the callback function to process a forwarder state message.

static void DtAssistantForwarderCompInfoMgr::processForwarderStateMsgForConnection ( const DtAssistantForwarderStateMsg msg,
void *  usr 
)
static

Called to process a forwarder state message on behalf of an rtiAssistanttoAssistantClient that requested the data.

virtual void DtAssistantForwarderCompInfoMgr::processForwarderStateMsgForConnection ( const DtAssistantForwarderStateMsg msg)
virtual

Called by the callback function to process a federation state message on behalf of an rtiAssistanttoAssistantClient that requested the data.

void DtAssistantForwarderCompInfoMgr::provideForwarderInfo ( const DtRtiConnectionInfo conn,
const DtAssistantForwarderInfo **  info 
)
slot

Response to a query for forwarder info.

void DtAssistantForwarderCompInfoMgr::providePeerForwarderInfo ( const DtRtiConnectionInfo ,
std::vector< DtAssistantForwarderInfo > *   
)
slot

Response to a query for peer forwarder info.

virtual void DtAssistantForwarderCompInfoMgr::pruneTimedOutSingleUpdates ( )
protectedvirtual

If there were RTI Forwarder updates that timed out, we send back the incomplete msg.

virtual void DtAssistantForwarderCompInfoMgr::requestSingleUpdateFromConnectedForwarders ( int  id)
virtual

Performs a single data request of the connected RTI Forwarders.

void DtAssistantForwarderCompInfoMgr::sendAllForwarderInfo ( )
slot

Sends udpate message for all local conns to remote assistants.

void DtAssistantForwarderCompInfoMgr::sendObserveForwarderMsgForViewedPeers ( bool  shouldObserve = true)
slot

Sends a message to the peers of the current connection that they are being observed by this assistant.

void DtAssistantForwarderCompInfoMgr::sendObserveForwarderMsgToPeer ( bool  shouldObserve = true)
slot

This Assistant is viewing or stopped viewing a remote forwarder.

Send an observe forwarder message to the forwarder's assistant.

virtual void DtAssistantForwarderCompInfoMgr::tick ( )
virtual

Performs tasks that need to be completed periodically.

Reimplemented from DtAssistantMgr.

virtual void DtAssistantForwarderCompInfoMgr::updateObservedPeers ( const DtRtiConnectionInfo conn,
bool  addOrRemove 
)
virtual

Update set of stored observed rtiForwarder connections.

virtual void DtAssistantForwarderCompInfoMgr::viewNetworkComponentsForConnection ( const DtRtiConnectionInfo conn)
virtual

Sets the connection which is currently being viewed.

Member Data Documentation

MAKRti::DtClock DtAssistantForwarderCompInfoMgr::myClock
protected

Clock used to determine if we need to resend lost messages.

std::shared_ptr<DtAssistantComponentMgr> DtAssistantForwarderCompInfoMgr::myCompMgr
protected

The local RTI component manager.

std::shared_ptr<DtAssistantConnectionInfoMgr> DtAssistantForwarderCompInfoMgr::myConnInfoMgr
protected

The connection info manager.

float DtAssistantForwarderCompInfoMgr::myDefunctRemovalTime
protected

Defunct removal time for dropped federates.

DtForwarderStateByConnectionMap DtAssistantForwarderCompInfoMgr::myLocalForwarders
protected

information on all local forwarders.

std::set<DtRtiConnectionInfo> DtAssistantForwarderCompInfoMgr::myObservedPeerRtiForwarderSet
protected
DtForwarderStateByConnectionMap DtAssistantForwarderCompInfoMgr::myRemoteForwarders
protected

information on all known remote forwarders.

DtConnectionToObserversMap DtAssistantForwarderCompInfoMgr::myRemotelyViewedRtiForwarders
protected

Local forwarder connections currently being viewed by remote Assistants, and the set of all Assistants which are viewing them.

std::map<std::pair<int, MAKRti::DtTime>, std::map<int, MAKRti::DtString> > DtAssistantForwarderCompInfoMgr::myRequestedRtiForwarderUpdates
protected
unsigned int DtAssistantForwarderCompInfoMgr::myTimeStateUpdateInterval
protected

The interval, in ms, at which local rtiForwarders should be requested to send updated time state information from local rtiForwarders.

Takes into account remote assistants as well.

DtRtiConnectionInfo DtAssistantForwarderCompInfoMgr::myViewedRtiForwarder
protected

The forwarder connection currently being viewed at this Assistant.

const int DtAssistantForwarderCompInfoMgr::theTimeToWaitForForwarderInfo
staticprotected

The time, in seconds, to wait for information from the remotely viewed RTI Forwarder before resending the observation request.


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)