DtIfRequestScriptedTasks Class Reference

Interface content message for requesting information for scripted tasks. More...

Inheritance diagram for DtIfRequestScriptedTasks:

Public Member Functions
	DtIfRequestScriptedTasks ()
	default constructor
	DtIfRequestScriptedTasks (const DtIfRequestScriptedTasks &orig)
	copy constructor
DtIfRequestScriptedTasks &	operator= (const DtIfRequestScriptedTasks &orig)
	assignment operator
virtual	~DtIfRequestScriptedTasks ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual void	setProvideScript (bool)
	If true will return the actual script with the meta data. Default is false.
virtual bool	provideScript () const
virtual void	setLanguage (const std::string &lang)
	Specify the language to get for translations. If language is empty no language information will be provided.
virtual const std::string &	language () const
virtual void	setRequestId (DtU32)
	Request id to match for response.
virtual DtU32	requestId () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual const std::vector < std::string > &	scriptIds () const
	A vector containing ids of the scripts to look up.
virtual void	addScriptId (const std::string &name)
	A vector containing ids of the scripts to look up.
virtual void	setScriptIds (const std::vector< std::string > &)
	A vector containing ids of the scripts to look up.

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
std::vector< std::string >	myScriptIds
std::string	myLanguage
DtU32	myRequestId
bool	myProvideScript

Detailed Description

Interface content message for requesting information for scripted tasks.

If no ids are supplied all tasks are returned. The response message will contain the request id if supplied.

Constructor & Destructor Documentation

DtIfRequestScriptedTasks::DtIfRequestScriptedTasks

(

)

default constructor

DtIfRequestScriptedTasks::DtIfRequestScriptedTasks

(

const DtIfRequestScriptedTasks &

orig

)

copy constructor

virtual DtIfRequestScriptedTasks::~DtIfRequestScriptedTasks ( )

virtual

Member Function Documentation

DtIfRequestScriptedTasks& DtIfRequestScriptedTasks::operator=

(

const DtIfRequestScriptedTasks &

orig

)

assignment operator

virtual int DtIfRequestScriptedTasks::type ( ) const

virtual

virtual DtSimInterfaceContent* DtIfRequestScriptedTasks::clone ( ) const

virtual

virtual const std::vector<std::string>& DtIfRequestScriptedTasks::scriptIds ( ) const

virtual

A vector containing ids of the scripts to look up.

virtual void DtIfRequestScriptedTasks::addScriptId ( const std::string &  name )

virtual

A vector containing ids of the scripts to look up.

virtual void DtIfRequestScriptedTasks::setScriptIds ( const std::vector< std::string > &  )

virtual

A vector containing ids of the scripts to look up.

virtual void DtIfRequestScriptedTasks::setProvideScript ( bool  )

virtual

If true will return the actual script with the meta data. Default is false.

virtual bool DtIfRequestScriptedTasks::provideScript ( ) const

virtual

virtual void DtIfRequestScriptedTasks::setLanguage ( const std::string &  lang )

virtual

Specify the language to get for translations. If language is empty no language information will be provided.

virtual const std::string& DtIfRequestScriptedTasks::language ( ) const

virtual

virtual void DtIfRequestScriptedTasks::setRequestId ( DtU32  )

virtual

Request id to match for response.

virtual DtU32 DtIfRequestScriptedTasks::requestId ( ) const

virtual

virtual int DtIfRequestScriptedTasks::netRepSize ( ) const

virtual

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

virtual

virtual bool DtIfRequestScriptedTasks::setToNet ( )

virtual

virtual void DtIfRequestScriptedTasks::printDataToString ( DtString &  str )

virtual

static DtSimInterfaceContent* DtIfRequestScriptedTasks::creator ( )

static

Member Data Documentation

std::vector<std::string> DtIfRequestScriptedTasks::myScriptIds

protected

std::string DtIfRequestScriptedTasks::myLanguage

protected

DtU32 DtIfRequestScriptedTasks::myRequestId

protected

bool DtIfRequestScriptedTasks::myProvideScript

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfmsgs/ifRequestScriptedTasks.h