Process Helper class to handle user questions.

Inheritance diagram for DtRwUserQuestionHandler:

Public Member Functions
	DtRwUserQuestionHandler (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=0)

	DtRwUserQuestionHandler (const DtRwUserQuestionHandler &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)

const DtRwUserQuestionHandler &	operator= (const DtRwUserQuestionHandler &orig)

virtual	~DtRwUserQuestionHandler ()


virtual int	currentQuestionId (const DtString &) const

virtual int	outstandingQuestionId (const DtString &) const

virtual DtString	scriptIdFor (int) const

virtual int	askUserQuestion (const DtString &scriptId, const DtRwTranslatableStringObject &title, const DtRwTranslatableStringObject &message, const std::vector< DtRwTranslatableStringObject > &options, int displayFlag)

virtual bool	userQuestionData (int questionId, DtString &scriptId, DtRwTranslatableStringObject &title, DtRwTranslatableStringObject &message, std::vector< DtRwTranslatableStringObject > &options, int &displayFlag) const

virtual int	statusOfUserQuestion (int) const

virtual bool	cancelUserQuestion (int)

virtual void	cancelUserResponse (const DtString &scriptId)

virtual void	processUserResponse (const DtIfUserQuestionOperation &)

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Types
typedef DtRwTemplatedListPtr < DtRwUserQuestion, true >	UserQuestions

typedef DtRwTemplatedListPtr < DtScriptedTaskTask, true >	UserResponses

Protected Member Functions
virtual int	nextQuestionId ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
UserQuestions	myUserQuestions

UserResponses	myUserResponses

int	myQuestionId

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwUserQuestion, true> DtRwUserQuestionHandler::UserQuestions

protected

typedef DtRwTemplatedListPtr<DtScriptedTaskTask, true> DtRwUserQuestionHandler::UserResponses

protected

Constructor & Destructor Documentation

DtRwUserQuestionHandler::DtRwUserQuestionHandler	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwUserQuestionHandler::DtRwUserQuestionHandler	(	const DtRwUserQuestionHandler &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtRwUserQuestionHandler::~DtRwUserQuestionHandler ( )

virtual

Member Function Documentation

const DtRwUserQuestionHandler& DtRwUserQuestionHandler::operator= ( const DtRwUserQuestionHandler & orig )

virtual int DtRwUserQuestionHandler::currentQuestionId ( const DtString & ) const

virtual

User question methods.

Returns the question id for the script id if it exists. If there is no question -1 is returnd. A pending question might have been answered. Use outstandingQuestionId to see if ther is an unanswered question for this script

virtual int DtRwUserQuestionHandler::outstandingQuestionId ( const DtString & ) const

virtual

Any unanswered question for the given script id.

virtual DtString DtRwUserQuestionHandler::scriptIdFor ( int ) const

virtual

Returns the script that is associated with the supplied question id or the empty string if no question id exists.

virtual int DtRwUserQuestionHandler::askUserQuestion	(	const DtString &	scriptId,
		const DtRwTranslatableStringObject &	title,
		const DtRwTranslatableStringObject &	message,
		const std::vector< DtRwTranslatableStringObject > &	options,
		int	displayFlag
	)

virtual

Adds a new question for the provided script id. If there is an existing question for a script id it is cancelled before this new one is added. The new question id is returned.

virtual bool DtRwUserQuestionHandler::userQuestionData	(	int	questionId,
		DtString &	scriptId,
		DtRwTranslatableStringObject &	title,
		DtRwTranslatableStringObject &	message,
		std::vector< DtRwTranslatableStringObject > &	options,
		int &	displayFlag
	)		const

virtual

Returns the data associated with the supplied question id. Returns false if question id does not exist.

virtual int DtRwUserQuestionHandler::statusOfUserQuestion ( int ) const

virtual

Returns the response for the specified user question id. If there is no response or the id does no exist returns -1.

virtual bool DtRwUserQuestionHandler::cancelUserQuestion ( int )

virtual

Cancels the supplied question. Returns true if the question is cancelled.

virtual void DtRwUserQuestionHandler::cancelUserResponse ( const DtString & scriptId )

virtual

User question methods.

Returns the question id for the script id if it exists. If there is no question -1 is returnd. A pending question might have been answered. Use outstandingQuestionId to see if ther is an unanswered question for this script

virtual void DtRwUserQuestionHandler::processUserResponse ( const DtIfUserQuestionOperation & )

virtual

User question methods.

Returns the question id for the script id if it exists. If there is no question -1 is returnd. A pending question might have been answered. Use outstandingQuestionId to see if ther is an unanswered question for this script

virtual int DtRwUserQuestionHandler::nextQuestionId ( )

protectedvirtual

Returns the next question id (max id + 1)

Member Data Documentation

UserQuestions DtRwUserQuestionHandler::myUserQuestions

protected

UserResponses DtRwUserQuestionHandler::myUserResponses

protected

int DtRwUserQuestionHandler::myQuestionId

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/rwUserQuestionHandler.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation