 |
MAK RTIspy API Documentation for HLA Evolved
|
|
MAK RTIspy API Documentation for HLA Evolved
|
DtAssistantPopupHelper inherits from DtPopupHelper. More...
Inheritance diagram for DtAssistantPopupHelper: Collaboration diagram for DtAssistantPopupHelper:Public Member Functions | |
| virtual | ~DtAssistantPopupHelper () |
| Destructor. | |
Static Public Member Functions | |
| static void | popupAssistantMessage (const MAKRti::DtString &text, MAKRti::DtOutputStream &stream, const MAKRti::DtString &advancedText) |
| Call theCreator function to create a popupMessage to the assistant. | |
| static void | popupAssistantMessage (const MAKRti::DtString &text, MAKRti::DtOutputStream &stream=MAKRti::DtWarn) |
| static void | setCreatorFunction (DtRtiAssistantClient *client) |
| sets the base creator to use the assitantPopupWindow and associates | |
| static void | removeClientReference () |
| Removes reference to DtRtiAssistantClient. | |
| static void | setAssistantPrinter (DtAssistantPrinter *printer) |
| Store a pointer to the printer used to send notifications to the assistant. | |
| static void | removeAssistantPrinter () |
| Remove reference to assistant printer. | |
| static void | setPopupsDisabled (bool popupsDisabled) |
| Ignore calls to popupAssistantMsg if popupsDisabled is set. | |
| static bool | popupsDisabled () |
| returns whether popups are disabled | |
| static void | queuePopups () |
| Tells the popup helper to queue up popup messages, but not to send them yet. | |
| static void | sendAllPopups (MAKRti::DtTime sleepTime=0.0) |
| Tells the popup helper to send all queued popup messages. | |
Protected Member Functions | |
| DtAssistantPopupHelper (const MAKRti::DtString &text, const MAKRti::DtString &advancedText) | |
| Constructor. | |
| virtual void | sendPopupMessage (const MAKRti::DtString &message, const MAKRti::DtString &advancedText) |
| Packages the data into a message and sends to the RTI Assistant to be displayed as a popup dialog. | |
Static Protected Attributes | |
| static DtRtiAssistantClient * | theClient = 0 |
| The Assistant client connection through which messages are sent. | |
| static DtAssistantPrinter * | thePrinter = 0 |
| The printer that sends notifications to the assistant. | |
| static bool | theQueuePopups = false |
| Indicates whether or not popup message queuing is enabled. | |
| static bool | thePopupsDisabled = false |
| Are popups disabled? | |
| static std::list< std::pair < MAKRti::DtString, MAKRti::DtString > > | thePopupQueue |
| The queue of messages which need to be sent to the Assistant. | |
| static MAKRti::DtMutex | theMutex |
| The mutex protecting thePopupQueue. | |
Private Member Functions | |
| DtAssistantPopupHelper () | |
| Default Ctor disabled. | |
| DtAssistantPopupHelper (const DtAssistantPopupHelper &orig) | |
| Copy and assignment operators are disabled. | |
| DtAssistantPopupHelper & | operator= (DtAssistantPopupHelper const &orig) |
DtAssistantPopupHelper inherits from DtPopupHelper.
It sets the DtPopupHelper factory method to use DtAssistantPopupHelper. After the factory method is set, calls to DtAssistantPopupHelper::popupAssistantMessage will result in an Assistant popup.
| DtAssistantPopupHelper::DtAssistantPopupHelper | ( | const MAKRti::DtString & | text, |
| const MAKRti::DtString & | advancedText | ||
| ) | [protected] |
Constructor.
References sendPopupMessage().
| DtAssistantPopupHelper::~DtAssistantPopupHelper | ( | ) | [virtual] |
Destructor.
| DtAssistantPopupHelper::DtAssistantPopupHelper | ( | ) | [private] |
Default Ctor disabled.
Referenced by sendAllPopups().
| DtAssistantPopupHelper::DtAssistantPopupHelper | ( | const DtAssistantPopupHelper & | orig | ) | [private] |
Copy and assignment operators are disabled.
| DtAssistantPopupHelper& DtAssistantPopupHelper::operator= | ( | DtAssistantPopupHelper const & | orig | ) | [private] |
| static void DtAssistantPopupHelper::popupAssistantMessage | ( | const MAKRti::DtString & | text, |
| MAKRti::DtOutputStream & | stream, | ||
| const MAKRti::DtString & | advancedText | ||
| ) | [static] |
Call theCreator function to create a popupMessage to the assistant.
Also outputs the text to the given output stream.
Reimplemented from DtPopupHelper.
Referenced by DtRtiExecFederateMgr::checkJoinResponse(), DtSmConnectionMgr::connectFederation(), DtRtiExecFederateMgr::createFederationExecution(), DtRtiExecFederateMgr::destroyFederationExecution(), DtRtiMsgForwarder::init(), DtFedExec::init(), DtSmConnectionMgr::initConnections(), DtConnectionMgr::initConnections(), initControl(), DtRtiExecFederateMgr::initializeFOM(), DtRtiExecFederateMgr::initializeTimeFactory(), DtFomClassMgr::initUpdateRates(), DtRtiExecFederateMgr::joinFederationExecution(), DtRouteMap::openRoutesFile(), DtRtiMsgForwarder::performMcastDiscovery(), DtRtiExec::performMulticastDiscovery(), DtFedExec::processJoinMsg(), DtPartnerMgr::processPartnerReject(), DtFederateMgr::readFedFile(), DtFederateMgr::readFedFilePtr(), DtAsyncFileDistributorRunnable::run(), setCreatorFunction(), DtFederateMgr::testReadFedFile(), DtRtiExecFederateMgr::testReadFomModules(), DtObjectMgr::uniqueHandle(), and DtRtiExecFederateMgr::waitForJoinResponse().
| static void DtAssistantPopupHelper::popupAssistantMessage | ( | const MAKRti::DtString & | text, |
| MAKRti::DtOutputStream & | stream = MAKRti::DtWarn |
||
| ) | [static] |
| bool DtAssistantPopupHelper::popupsDisabled | ( | ) | [static] |
returns whether popups are disabled
References thePopupsDisabled.
Referenced by DtRtiExec::DtRtiExec(), and setPopupsDisabled().
| void DtAssistantPopupHelper::queuePopups | ( | ) | [static] |
Tells the popup helper to queue up popup messages, but not to send them yet.
Messages will be sent when DtAssistantPopupHelper::sendAllPopups is called. This is useful if you want to delay the sending of popup messages to the assistant until some point in the future without losing the messages.
References theMutex, and theQueuePopups.
| void DtAssistantPopupHelper::removeAssistantPrinter | ( | ) | [static] |
Remove reference to assistant printer.
References thePrinter.
Referenced by DtAssistantPrinter::~DtAssistantPrinter().
| void DtAssistantPopupHelper::removeClientReference | ( | ) | [static] |
Removes reference to DtRtiAssistantClient.
Resets creator Function.
References DtPopupHelper::popupAssistantMessage(), and setCreatorFunction().
| void DtAssistantPopupHelper::sendAllPopups | ( | MAKRti::DtTime | sleepTime = 0.0 | ) | [static] |
Tells the popup helper to send all queued popup messages.
This also disables popup message queuing. If sleep time is greater than 0, this call will sleep before returning
References DtAssistantPopupHelper(), theMutex, thePopupQueue, and theQueuePopups.
| void DtAssistantPopupHelper::sendPopupMessage | ( | const MAKRti::DtString & | message, |
| const MAKRti::DtString & | advancedText | ||
| ) | [protected, virtual] |
Packages the data into a message and sends to the RTI Assistant to be displayed as a popup dialog.
References DtRtiAssistantClient::sendDialogBoxMsg(), and theClient.
Referenced by DtAssistantPopupHelper().
| void DtAssistantPopupHelper::setAssistantPrinter | ( | DtAssistantPrinter * | printer | ) | [static] |
Store a pointer to the printer used to send notifications to the assistant.
References thePrinter.
Referenced by DtAssistantPrinter::DtAssistantPrinter().
| void DtAssistantPopupHelper::setCreatorFunction | ( | DtRtiAssistantClient * | client | ) | [static] |
sets the base creator to use the assitantPopupWindow and associates
DtAssistantPopupHelper::popupAssistantMessage with a particular assistantClient. Only intended to be used by the implementation of DtRtiAssistantClient
References popupAssistantMessage().
Referenced by DtRtiAssistantClient::DtRtiAssistantClient(), and removeClientReference().
| void DtAssistantPopupHelper::setPopupsDisabled | ( | bool | popupsDisabled | ) | [static] |
Ignore calls to popupAssistantMsg if popupsDisabled is set.
Popups are enabled by default.
References popupsDisabled(), and thePopupsDisabled.
Referenced by DtRtiExec::DtRtiExec().
DtRtiAssistantClient * DtAssistantPopupHelper::theClient = 0 [static, protected] |
The Assistant client connection through which messages are sent.
Referenced by sendPopupMessage().
DtMutex DtAssistantPopupHelper::theMutex [static, protected] |
The mutex protecting thePopupQueue.
Referenced by queuePopups(), and sendAllPopups().
std::list< std::pair< DtString, MAKRti::DtString > > DtAssistantPopupHelper::thePopupQueue [static, protected] |
The queue of messages which need to be sent to the Assistant.
Only used when queuing is turned on.
Referenced by sendAllPopups().
bool DtAssistantPopupHelper::thePopupsDisabled = false [static, protected] |
Are popups disabled?
Referenced by popupsDisabled(), and setPopupsDisabled().
DtAssistantPrinter * DtAssistantPopupHelper::thePrinter = 0 [static, protected] |
The printer that sends notifications to the assistant.
Referenced by removeAssistantPrinter(), and setAssistantPrinter().
bool DtAssistantPopupHelper::theQueuePopups = false [static, protected] |
Indicates whether or not popup message queuing is enabled.
Referenced by queuePopups(), and sendAllPopups().
