DtScriptedTask Class Reference

The DtScriptedTaskTask will encapsulate the variables defined by a scripted task in the variable bindings object. More...

Inheritance diagram for DtScriptedTask:

Classes
class	ScriptedTaskFormatter

Public Member Functions
	DtScriptedTask ()
virtual	~DtScriptedTask ()
virtual bool	init ()=0
	Initializer.
virtual const DtString &	scriptId () const =0
	Script id.
virtual void	setScriptId (const DtString &)=0
virtual DtRwVariableBindings &	variables ()=0
	Access to variables.
virtual const DtRwVariableBindings &	variables () const =0
virtual DtRwVariableBindings &	variableDataTypes ()=0
	Access to the data types that represent the variables.
virtual const DtRwVariableBindings &	variableDataTypes () const =0
virtual DtString	allVariablesStringRep (const DtString &scriptName="") const =0
virtual int	netRepSize () const =0
	Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)=0
	Fills in the task from the network buffer.
virtual char *	setToNet (char *)=0

Static Public Member Functions
static void	setScriptedTaskFormatter (ScriptedTaskFormatter *)
static ScriptedTaskFormatter *	scriptedTaskFormatter ()

Static Protected Attributes
static ScriptedTaskFormatter *	theScriptedTaskFormatter

Detailed Description

The DtScriptedTaskTask will encapsulate the variables defined by a scripted task in the variable bindings object.

The variable bindings will contain the variable name, the type of object and the variables value. This class will also contain the script id of the script that should be run with these valuesMinimal set of items a scripted task (or set) must implement to be considered a scripted task/set

Constructor & Destructor Documentation

DtScriptedTask::DtScriptedTask ( )

inline

virtual DtScriptedTask::~DtScriptedTask ( )

inlinevirtual

Member Function Documentation

virtual bool DtScriptedTask::init ( )

pure virtual

Initializer.

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual const DtString& DtScriptedTask::scriptId ( ) const

pure virtual

Script id.

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual void DtScriptedTask::setScriptId ( const DtString &  )

pure virtual

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual DtRwVariableBindings& DtScriptedTask::variables ( )

pure virtual

Access to variables.

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual const DtRwVariableBindings& DtScriptedTask::variables ( ) const

pure virtual

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual DtRwVariableBindings& DtScriptedTask::variableDataTypes ( )

pure virtual

Access to the data types that represent the variables.

This is the internal scripted task data type separate from the rw type

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual const DtRwVariableBindings& DtScriptedTask::variableDataTypes ( ) const

pure virtual

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual int DtScriptedTask::netRepSize ( ) const

pure virtual

Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Network transfer

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

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

pure virtual

Fills in the task from the network buffer.

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

virtual char* DtScriptedTask::setToNet ( char *  )

pure virtual

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

static void DtScriptedTask::setScriptedTaskFormatter ( ScriptedTaskFormatter *  )

static

static ScriptedTaskFormatter* DtScriptedTask::scriptedTaskFormatter ( )

static

virtual DtString DtScriptedTask::allVariablesStringRep ( const DtString &  scriptName = "" ) const

pure virtual

Implemented in DtScriptedTaskTemplate< T >, DtScriptedTaskTemplate< DtSimTask >, and DtScriptedTaskTemplate< DtSetDataRequest >.

Member Data Documentation

ScriptedTaskFormatter* DtScriptedTask::theScriptedTaskFormatter

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrftasks/scriptedTaskTask.h