MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
assistantPopupHelper.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2008 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: assistantPopupHelper.h,v $ $Revision: 1.11 $ $State: Exp $
7 *********************************************************************/
8 
11 
12 #ifndef DtAssistantPopupHelper_H_
13 #define DtAssistantPopupHelper_H_
14 
15 #include <rtiMsConfig.h>
16 #include "rtiAssistantClient.h"
17 #include "assistantPrinter.h"
18 #include <popupHelper.h>
19 
20 
27 {
28 
29 protected:
30 
32  DtAssistantPopupHelper( const MAKRti::DtString& text, const MAKRti::DtString& advancedText );
33 
34 public:
35 
38  static void popupAssistantMessage(const MAKRti::DtString& text,
39  MAKRti::DtOutputStream& stream, const MAKRti::DtString& advancedText);
40  static void popupAssistantMessage(const MAKRti::DtString& text,
41  MAKRti::DtOutputStream& stream = MAKRti::DtWarn );
42 
44  virtual ~DtAssistantPopupHelper();
45 
49  static void setCreatorFunction( DtRtiAssistantClient* client );
50 
53  static void removeClientReference();
54 
57  static void setAssistantPrinter( DtAssistantPrinter* printer );
58 
60  static void removeAssistantPrinter();
61 
64  static void setPopupsDisabled(bool popupsDisabled);
65 
67  static bool popupsDisabled();
68 
69 
75  static void queuePopups();
76 
80  static void sendAllPopups(MAKRti::DtTime sleepTime=0.0);
81 
82 protected:
83 
86  virtual void sendPopupMessage( const MAKRti::DtString& message,
87  const MAKRti::DtString& advancedText );
88 
89 private:
90 
93 
97 
98 protected:
99 
102 
105 
107  static bool theQueuePopups;
108 
110  static bool thePopupsDisabled;
111 
114  static std::list<std::pair<MAKRti::DtString, MAKRti::DtString> > thePopupQueue;
115 
117  static MAKRti::DtMutex theMutex;
118 
119 };
120 
121 
122 
123 #endif
124 
static bool theQueuePopups
Indicates whether or not popup message queuing is enabled.
Definition: assistantPopupHelper.h:107
This file contains the declaration of DtAssistantPrinter.
DtAssistantPopupHelper inherits from DtPopupHelper.
Definition: assistantPopupHelper.h:26
static void popupAssistantMessage(const MAKRti::DtString &text, MAKRti::DtOutputStream &stream=MAKRti::DtWarn, const MAKRti::DtString &advancedText=MAKRti::DtString(""))
Call theCreator function to create a popupMessage to the assistant.
DtPopupHelper & operator=(DtPopupHelper const &orig)
Manages the client connection to the RTI Assistant.
Definition: rtiAssistantClient.h:59
static void setCreatorFunction(DtPopupHelperCreator creator)
Call this function to set an alternate creator function With this function, users can replace this Dt...
DtPopupHelper is a base popupHelper class.
Definition: popupHelper.h:32
Sends data from an output stream to the RTI Assistant.
Definition: assistantPrinter.h:33
#define DT_DLL_ASSISTANT
Default – Unix or Win32 static.
Definition: rtiMsConfig.h:150
Contains the DtRtiAssistantClient class declaration.
static MAKRti::DtMutex theMutex
The mutex protecting thePopupQueue.
Definition: assistantPopupHelper.h:117
static DtAssistantPrinter * thePrinter
The printer that sends notifications to the assistant.
Definition: assistantPopupHelper.h:104
static std::list< std::pair< MAKRti::DtString, MAKRti::DtString > > thePopupQueue
The queue of messages which need to be sent to the Assistant.
Definition: assistantPopupHelper.h:114
static bool thePopupsDisabled
Are popups disabled?
Definition: assistantPopupHelper.h:110
static DtRtiAssistantClient * theClient
The Assistant client connection through which messages are sent.
Definition: assistantPopupHelper.h:101

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)