DtIfUserQuestionOperation Class Reference

The DtIfUserQuestionOperation class will be used to either cancel a user question or supply a response to a user question. More...

Inheritance diagram for DtIfUserQuestionOperation:

Public Member Functions
	DtIfUserQuestionOperation ()
	default constructor
virtual	~DtIfUserQuestionOperation ()
	destructor
	DtIfUserQuestionOperation (const DtIfUserQuestionOperation &orig)
	copy constructor
DtIfUserQuestionOperation &	operator= (const DtIfUserQuestionOperation &orig)
	assignment operator
virtual int	type () const
	Returns the type of Interface Content; DtRemoveEntityMessageName.
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	setOperation (int)
	Sets the operation.
virtual int	operation () const
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 int	questionId () const
virtual const DtUUID &	entity () const
virtual void	setResponse (const DtScriptedTaskTask &)
	Sets the values that are used as a response to this question.
virtual const DtScriptedTaskTask &	response () const
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
int	myOperation
DtString	myScriptId
int	myQuestionId
DtUUID	myEntity
DtScriptedTaskTask	myResponse
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

The DtIfUserQuestionOperation class will be used to either cancel a user question or supply a response to a user question.

While the response to the question allows for a complex response to be included in the message, currently (in 4.3 of VR-Forces) only a single operation response is allowed. This will be a DtRwInt that contains the selection with the RW name "UserQuestionResponse"

Constructor & Destructor Documentation

DtIfUserQuestionOperation::DtIfUserQuestionOperation

(

)

default constructor

virtual DtIfUserQuestionOperation::~DtIfUserQuestionOperation ( )

virtual

destructor

DtIfUserQuestionOperation::DtIfUserQuestionOperation

(

const DtIfUserQuestionOperation &

orig

)

copy constructor

Member Function Documentation

DtIfUserQuestionOperation& DtIfUserQuestionOperation::operator=

(

const DtIfUserQuestionOperation &

orig

)

assignment operator

virtual int DtIfUserQuestionOperation::type ( ) const

virtual

Returns the type of Interface Content; DtRemoveEntityMessageName.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfUserQuestionOperation::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfUserQuestionOperation::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfUserQuestionOperation::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfUserQuestionOperation::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfUserQuestionOperation::creator ( )

static

virtual void DtIfUserQuestionOperation::setOperation ( int  )

virtual

Sets the operation.

Values can be: 0 - Cancel question 1 - Question response 2 - Request all outstanding messages of either the entity or all entities (blank entity name), and optional script id

virtual int DtIfUserQuestionOperation::operation ( ) const

virtual

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

virtual

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

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

virtual

virtual const DtString& DtIfUserQuestionOperation::scriptId ( ) const

virtual

virtual int DtIfUserQuestionOperation::questionId ( ) const

virtual

virtual const DtUUID& DtIfUserQuestionOperation::entity ( ) const

virtual

virtual void DtIfUserQuestionOperation::setResponse ( const DtScriptedTaskTask &  )

virtual

Sets the values that are used as a response to this question.

It is in the form of a scripted task task reader/writer item

virtual const DtScriptedTaskTask& DtIfUserQuestionOperation::response ( ) const

virtual

Member Data Documentation

int DtIfUserQuestionOperation::myOperation

protected

DtString DtIfUserQuestionOperation::myScriptId

protected

int DtIfUserQuestionOperation::myQuestionId

protected

DtUUID DtIfUserQuestionOperation::myEntity

protected

DtScriptedTaskTask DtIfUserQuestionOperation::myResponse

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifUserQuestionOperation.h