DtIfAskUserQuestion Class Reference

DtIfAskUserQuestion class will allow the back-end to send a message to the front end to ask the user a question based on the supplied script id and question id. More...

Inheritance diagram for DtIfAskUserQuestion:

Public Member Functions
	DtIfAskUserQuestion ()
	default constructor
virtual	~DtIfAskUserQuestion ()
	destructor
	DtIfAskUserQuestion (const DtIfAskUserQuestion &orig)
	copy constructor
DtIfAskUserQuestion &	operator= (const DtIfAskUserQuestion &orig)
	assignment operator
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual void	setQuestionRespondingTo (const DtString &scriptId, const DtUUID &entity, int questionId)
	Sets the script id and question id that this operation represents.
virtual void	questionRespondingTo (DtString &scriptId, DtUUID &entity, int &questionId) const
virtual const DtString &	scriptId () const
virtual const DtUUID &	entity () const
virtual int	questionId () const
virtual void	setOptions (const std::vector< DtRwTranslatableStringObject > &)
	Sets the options to display to the user.
virtual std::vector < DtRwTranslatableStringObject >	options () const
virtual void	setTitle (const DtRwTranslatableStringObject &)
	Message box title accessors.
virtual const DtRwTranslatableStringObject &	title () const
virtual void	setMessage (const DtRwTranslatableStringObject &)
	Message box message body accessors.
virtual const DtRwTranslatableStringObject &	message () const
virtual void	setDisplayFlags (int)
	Display flag accessors.
virtual int	displayFlags () const
const DtRwUserQuestion &	question () const
	Returns the user question class.
DtRwUserQuestion &	question ()
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtRwUserQuestion	myUserQuestion
DtUUID	myEntity
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Detailed Description

DtIfAskUserQuestion class will allow the back-end to send a message to the front end to ask the user a question based on the supplied script id and question id.

The front-end will display this message in the object console and the user can select the question to answer

Constructor & Destructor Documentation

DtIfAskUserQuestion::DtIfAskUserQuestion

(

)

default constructor

virtual DtIfAskUserQuestion::~DtIfAskUserQuestion ( )

virtual

destructor

DtIfAskUserQuestion::DtIfAskUserQuestion

(

const DtIfAskUserQuestion &

orig

)

copy constructor

Member Function Documentation

DtIfAskUserQuestion& DtIfAskUserQuestion::operator=

(

const DtIfAskUserQuestion &

orig

)

assignment operator

virtual int DtIfAskUserQuestion::type ( ) const

virtual

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfAskUserQuestion::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfAskUserQuestion::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfAskUserQuestion::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfAskUserQuestion::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfAskUserQuestion::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfAskUserQuestion::creator ( )

static

virtual void DtIfAskUserQuestion::setQuestionRespondingTo ( const DtString &  scriptId, const DtUUID &  entity, int  questionId  )

virtual

Sets the script id and question id that this operation represents.

virtual void DtIfAskUserQuestion::questionRespondingTo ( DtString &  scriptId, DtUUID &  entity, int &  questionId  ) const

virtual

virtual const DtString& DtIfAskUserQuestion::scriptId ( ) const

virtual

virtual const DtUUID& DtIfAskUserQuestion::entity ( ) const

virtual

virtual int DtIfAskUserQuestion::questionId ( ) const

virtual

virtual void DtIfAskUserQuestion::setOptions ( const std::vector< DtRwTranslatableStringObject > &  )

virtual

Sets the options to display to the user.

virtual std::vector<DtRwTranslatableStringObject> DtIfAskUserQuestion::options ( ) const

virtual

virtual void DtIfAskUserQuestion::setTitle ( const DtRwTranslatableStringObject &  )

virtual

Message box title accessors.

virtual const DtRwTranslatableStringObject& DtIfAskUserQuestion::title ( ) const

virtual

virtual void DtIfAskUserQuestion::setMessage ( const DtRwTranslatableStringObject &  )

virtual

Message box message body accessors.

virtual const DtRwTranslatableStringObject& DtIfAskUserQuestion::message ( ) const

virtual

virtual void DtIfAskUserQuestion::setDisplayFlags ( int  )

virtual

Display flag accessors.

Values currently supported are 0 - Buttons 1 - Radio buttons 2 - Combo box

virtual int DtIfAskUserQuestion::displayFlags ( ) const

virtual

const DtRwUserQuestion& DtIfAskUserQuestion::question ( ) const

inline

Returns the user question class.

DtRwUserQuestion& DtIfAskUserQuestion::question ( )

inline

Member Data Documentation

DtRwUserQuestion DtIfAskUserQuestion::myUserQuestion

protected

DtUUID DtIfAskUserQuestion::myEntity

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfmsgs/ifAskUserQuestion.h