DtAssistantPopupHelper Class Reference

DtAssistantPopupHelper inherits from DtPopupHelper. More...

Inheritance diagram for DtAssistantPopupHelper:

Collaboration diagram for DtAssistantPopupHelper:

Public Member Functions
virtual	~DtAssistantPopupHelper ()
	Destructor.
Public Member Functions inherited from DtPopupHelper
virtual	~DtPopupHelper ()
	Destructor.
	DtPopupHelper ()
	Default Ctor disabled.
	DtPopupHelper (const DtPopupHelper &orig)
	Copy and assignment operators are disabled.
DtPopupHelper &	operator= (DtPopupHelper const &orig)

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.
Static Public Member Functions inherited from DtPopupHelper
static void	setCreatorFunction (DtPopupHelperCreator creator)
	Call this function to set an alternate creator function With this function, users can replace this DtPopupHelper with their own derived class.

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.
Protected Member Functions inherited from DtPopupHelper
	DtPopupHelper (const MAKRti::DtString &text, const MAKRti::DtString &advancedText)
	Constructor.

Static Protected Attributes
static DtRtiAssistantClient *	theClient
	The Assistant client connection through which messages are sent.
static DtAssistantPrinter *	thePrinter
	The printer that sends notifications to the assistant.
static bool	theQueuePopups
	Indicates whether or not popup message queuing is enabled.
static bool	thePopupsDisabled
	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.
Static Protected Attributes inherited from DtPopupHelper
static DtPopupHelperCreator	theCreator

Private Member Functions
	DtAssistantPopupHelper ()
	Default Ctor disabled.
	DtAssistantPopupHelper (const DtAssistantPopupHelper &orig)
	Copy and assignment operators are disabled.
DtAssistantPopupHelper &	operator= (DtAssistantPopupHelper const &orig)

Detailed Description

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.

Constructor & Destructor Documentation

DtAssistantPopupHelper::DtAssistantPopupHelper ( const MAKRti::DtString &  text, const MAKRti::DtString &  advancedText  )

protected

Constructor.

virtual DtAssistantPopupHelper::~DtAssistantPopupHelper ( )

virtual

Destructor.

DtAssistantPopupHelper::DtAssistantPopupHelper ( )

private

Default Ctor disabled.

DtAssistantPopupHelper::DtAssistantPopupHelper ( const DtAssistantPopupHelper &  orig )

private

Copy and assignment operators are disabled.

Member Function Documentation

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.

static void DtAssistantPopupHelper::popupAssistantMessage ( const MAKRti::DtString &  text, MAKRti::DtOutputStream &  stream = MAKRti::DtWarn  )

static

static bool DtAssistantPopupHelper::popupsDisabled ( )

static

returns whether popups are disabled

static 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.

static void DtAssistantPopupHelper::removeAssistantPrinter ( )

static

Remove reference to assistant printer.

static void DtAssistantPopupHelper::removeClientReference ( )

static

Removes reference to DtRtiAssistantClient.

Resets creator Function.

static 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

virtual void DtAssistantPopupHelper::sendPopupMessage ( const MAKRti::DtString &  message, const MAKRti::DtString &  advancedText  )

protectedvirtual

Packages the data into a message and sends to the RTI Assistant to be displayed as a popup dialog.

static void DtAssistantPopupHelper::setAssistantPrinter ( DtAssistantPrinter *  printer )

static

Store a pointer to the printer used to send notifications to the assistant.

static 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

static void DtAssistantPopupHelper::setPopupsDisabled ( bool  popupsDisabled )

static

Ignore calls to popupAssistantMsg if popupsDisabled is set.

Popups are enabled by default.

Member Data Documentation

DtRtiAssistantClient* DtAssistantPopupHelper::theClient

staticprotected

The Assistant client connection through which messages are sent.

MAKRti::DtMutex DtAssistantPopupHelper::theMutex

staticprotected

The mutex protecting thePopupQueue.

std::list<std::pair<MAKRti::DtString, MAKRti::DtString> > DtAssistantPopupHelper::thePopupQueue

staticprotected

The queue of messages which need to be sent to the Assistant.

Only used when queuing is turned on.

bool DtAssistantPopupHelper::thePopupsDisabled

staticprotected

Are popups disabled?

DtAssistantPrinter* DtAssistantPopupHelper::thePrinter

staticprotected

The printer that sends notifications to the assistant.

bool DtAssistantPopupHelper::theQueuePopups

staticprotected

Indicates whether or not popup message queuing is enabled.

---

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

• assistantPopupHelper.h