DtIfRequestScriptedTasks Class Reference

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.

Inheritance diagram for DtIfRequestScriptedTasks:

Public Member Functions
	DtIfRequestScriptedTasks ()
	DtIfRequestScriptedTasks (const DtIfRequestScriptedTasks &orig)
DtIfRequestScriptedTasks &	operator= (const DtIfRequestScriptedTasks &orig)
virtual	~DtIfRequestScriptedTasks ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual void	setScriptType (const int)
virtual int	scriptType () const
virtual void	setProvideScript (bool)
virtual bool	provideScript () const
virtual void	setProvideUiLayout (bool)
virtual bool	provideUiLayout () const
virtual void	setLanguage (const std::string &lang)
virtual const std::string &	language () const
virtual void	setRequestId (DtU32)
virtual DtU32	requestId () const
virtual void	setChecksumsOnly (bool)
virtual bool	checksumsOnly () 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
virtual void	addScriptId (const std::string &name)
virtual void	setScriptIds (const std::vector< std::string > &)
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
std::vector< std::string >	myScriptIds
int	myScriptType
std::string	myLanguage
DtU32	myRequestId
bool	myProvideScript
bool	myProvideUiLayout
bool	myChecksumsOnly
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

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

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestScriptedTasks::clone ( ) const

virtual

Implements DtSimInterfaceContent.

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::setScriptType ( const int  )

virtual

set/get the type of the script. Used when the script ID is temporary and the message is getting a default template to edit.

virtual int DtIfRequestScriptedTasks::scriptType ( ) const

virtual

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::setProvideUiLayout ( bool  )

virtual

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

virtual bool DtIfRequestScriptedTasks::provideUiLayout ( ) 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 void DtIfRequestScriptedTasks::setChecksumsOnly ( bool  )

virtual

If true, only the checksums for the scripts will be returned.

virtual bool DtIfRequestScriptedTasks::checksumsOnly ( ) const

virtual

virtual int DtIfRequestScriptedTasks::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestScriptedTasks::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestScriptedTasks::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfRequestScriptedTasks::creator ( )

static

Member Data Documentation

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

protected

int DtIfRequestScriptedTasks::myScriptType

protected

For the case that this message is used with a temp script ID to fetch the script template for editing, the type is used to get the correct template. In other cases, scriptType is not used.

std::string DtIfRequestScriptedTasks::myLanguage

protected

DtU32 DtIfRequestScriptedTasks::myRequestId

protected

bool DtIfRequestScriptedTasks::myProvideScript

protected

bool DtIfRequestScriptedTasks::myProvideUiLayout

protected

bool DtIfRequestScriptedTasks::myChecksumsOnly

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfmsgs/ifRequestScriptedTasks.h