MAK RTIspy API Documentation for HLA 1.3: assistantPopupHelper.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2008 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: assistantPopupHelper.h,v $ $Revision: 1.11 $ $State: Exp $
00007 *********************************************************************/
00008 
00011 
00012 #ifndef DtAssistantPopupHelper_H_
00013 #define DtAssistantPopupHelper_H_
00014 
00015 #include <rtiMsConfig.h>
00016 #include "rtiAssistantClient.h"
00017 #include "assistantPrinter.h"
00018 #include <popupHelper.h>
00019 
00020 
00026 class DT_DLL_ASSISTANT DtAssistantPopupHelper : public DtPopupHelper
00027 {
00028 
00029 protected:
00030    
00032    DtAssistantPopupHelper( const MAKRti::DtString& text, const MAKRti::DtString& advancedText );
00033    
00034 public:
00035 
00038    static void popupAssistantMessage(const MAKRti::DtString& text,
00039       MAKRti::DtOutputStream& stream, const MAKRti::DtString& advancedText);
00040    static void popupAssistantMessage(const MAKRti::DtString& text,
00041       MAKRti::DtOutputStream& stream = MAKRti::DtWarn );
00042 
00044    virtual ~DtAssistantPopupHelper();
00045 
00049    static void setCreatorFunction( DtRtiAssistantClient* client );
00050    
00053    static void removeClientReference();
00054 
00057    static void setAssistantPrinter( DtAssistantPrinter* printer );
00058 
00060    static void removeAssistantPrinter();
00061 
00064    static void setPopupsDisabled(bool popupsDisabled);
00065 
00067    static bool popupsDisabled();
00068 
00069    
00075    static void queuePopups();
00076 
00080    static void sendAllPopups(MAKRti::DtTime sleepTime=0.0);
00081 
00082 protected:
00083 
00086    virtual void sendPopupMessage( const MAKRti::DtString& message,
00087       const MAKRti::DtString& advancedText );
00088 
00089 private:
00090 
00092    DtAssistantPopupHelper();
00093 
00095    DtAssistantPopupHelper(const DtAssistantPopupHelper& orig);
00096    DtAssistantPopupHelper& operator=(DtAssistantPopupHelper const& orig);
00097 
00098 protected:
00099 
00101    static DtRtiAssistantClient* theClient;
00102 
00104    static DtAssistantPrinter* thePrinter;
00105 
00107    static bool theQueuePopups;
00108 
00110    static bool thePopupsDisabled;
00111 
00114    static std::list<std::pair<MAKRti::DtString, MAKRti::DtString> > thePopupQueue;
00115 
00117    static MAKRti::DtMutex theMutex;
00118 
00119 };
00120 
00121 
00122 
00123 #endif //! DtAssistantPopupHelper_H_
00124