MAK RTIspy API Documentation for HLA 1516
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
DtPopupHelper Class Reference

DtPopupHelper is a base popupHelper class. More...

+ Inheritance diagram for DtPopupHelper:
+ Collaboration diagram for DtPopupHelper:

Public Member Functions

virtual ~DtPopupHelper ()
 Destructor.
 DtPopupHelper ()
 Default Ctor disabled.
 DtPopupHelper (const DtPopupHelper &orig)
 Copy and assignment operators are disabled.
DtPopupHelperoperator= (DtPopupHelper const &orig)

Static Public Member Functions

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

 DtPopupHelper (const MAKRti::DtString &text, const MAKRti::DtString &advancedText)
 Constructor.

Static Protected Attributes

static DtPopupHelperCreator theCreator = NULL

Detailed Description

DtPopupHelper is a base popupHelper class.

Its default factory constructor won't create an actual popup at the Assistant, but can be used by components that don't have a connection to the assistant. Once the factory method is reset to use the AssistantPopupHelper calls to DtPopupHelper::popupAssistantMessage will result in assistant Popups.

Constructor & Destructor Documentation

DtPopupHelper::DtPopupHelper ( const MAKRti::DtString &  text,
const MAKRti::DtString &  advancedText 
)
protected

Constructor.

DtPopupHelper::~DtPopupHelper ( )
virtual

Destructor.

DtPopupHelper::DtPopupHelper ( )

Default Ctor disabled.

DtPopupHelper::DtPopupHelper ( const DtPopupHelper orig)

Copy and assignment operators are disabled.

Member Function Documentation

DtPopupHelper& DtPopupHelper::operator= ( DtPopupHelper const &  orig)
void DtPopupHelper::popupAssistantMessage ( const MAKRti::DtString &  text,
MAKRti::DtOutputStream &  stream = MAKRti::DtWarn,
const MAKRti::DtString &  advancedText = MAKRti::DtString("") 
)
static

Call theCreator function to create a popupMessage to the assistant.

Also writes the output to the given output stream. default creator function needs to be overridden.

Reimplemented in DtAssistantPopupHelper.

Referenced by DtRIDParameters::applyAmbassadorCreationArguments(), checkPortWithName(), DtRIDParameters::checkUseRtiExec(), DtRIDParameters::initializeUpdateRates(), DtRIDParameters::loadLispFile(), DtAssistantPopupHelper::removeClientReference(), DtRIDParameters::sanityCheckRIDParameters(), and DtRIDParameters::verifyIpAddress().

void DtPopupHelper::setCreatorFunction ( DtPopupHelperCreator  creator)
static

Call this function to set an alternate creator function With this function, users can replace this DtPopupHelper with their own derived class.

Member Data Documentation

DtPopupHelperCreator DtPopupHelper::theCreator = NULL
staticprotected

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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)