DtScriptedTaskTemplate< T > Class Template Reference

Inheritance diagram for DtScriptedTaskTemplate< T >:

Public Member Functions
	DtScriptedTaskTemplate ()
	default constructor
	DtScriptedTaskTemplate (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtScriptedTaskTemplate (const DtString &writeName, const DtScriptedTaskTemplate &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
	DtScriptedTaskTemplate (const DtScriptedTaskTemplate &orig)
	copy constructor
const DtScriptedTaskTemplate &	operator= (const DtScriptedTaskTemplate &orig)
	assignment operator
virtual	~DtScriptedTaskTemplate ()
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual DtString	allVariablesStringRep (const DtString &scriptName="") const
	Returns all the variables in a single string.
virtual int	netRepSize () const
	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)
	Fills in the task from the network buffer.
virtual bool	init ()
	Initializer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
virtual char *	setToNet (char *)
virtual DtRwVariableBindings &	variables ()
	Access to variables.
virtual const DtRwVariableBindings &	variables () const
virtual void	setVariables (const DtRwVariableBindings &)
virtual DtRwVariableBindings &	variableDataTypes ()
	Access to the data types that represent the variables.
virtual const DtRwVariableBindings &	variableDataTypes () const
virtual void	setScriptId (const DtString &)
	Script to run.
virtual const DtString &	scriptId () const
	Script id.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference())
	Override to upgrade scripted objects from nlength string list to nlength uuid list.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
Public Member Functions inherited from DtScriptedTask
	DtScriptedTask ()
virtual	~DtScriptedTask ()

Protected Member Functions
virtual void	upgradeVariables ()

Protected Attributes
DtRwString	myScriptId
DtRwVariableBindings	myVariables
DtRwVariableBindings	myVariableDataTypes

Additional Inherited Members
Static Public Member Functions inherited from DtScriptedTask
static void	setScriptedTaskFormatter (ScriptedTaskFormatter *)
static ScriptedTaskFormatter *	scriptedTaskFormatter ()
Static Protected Attributes inherited from DtScriptedTask
static ScriptedTaskFormatter *	theScriptedTaskFormatter

Constructor & Destructor Documentation

template<class T>

DtScriptedTaskTemplate< T >::DtScriptedTaskTemplate

(

)

default constructor

template<class T>

DtScriptedTaskTemplate< T >::DtScriptedTaskTemplate	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a task 'put' itself, the writeName will preface the task.

template<class T>

DtScriptedTaskTemplate< T >::DtScriptedTaskTemplate	(	const DtString &	writeName,
		const DtScriptedTaskTemplate< T > &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

template<class T>

DtScriptedTaskTemplate< T >::DtScriptedTaskTemplate

(

const DtScriptedTaskTemplate< T > &

orig

)

copy constructor

template<class T>

virtual DtScriptedTaskTemplate< T >::~DtScriptedTaskTemplate ( )

virtual

Member Function Documentation

template<class T>

const DtScriptedTaskTemplate& DtScriptedTaskTemplate< T >::operator=

(

const DtScriptedTaskTemplate< T > &

orig

)

assignment operator

template<class T>

virtual DtString DtScriptedTaskTemplate< T >::stringRep ( ) const

virtual

Get a readable string representation of this task.

If a formatter is assigned calls the formatter, else calls allVariablesStringRep()

template<class T>

virtual DtString DtScriptedTaskTemplate< T >::allVariablesStringRep ( const DtString &  scriptName = "" ) const

virtual

Returns all the variables in a single string.

Implements DtScriptedTask.

template<class T>

virtual int DtScriptedTaskTemplate< T >::netRepSize ( ) const

virtual

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

Implements DtScriptedTask.

template<class T>

virtual bool DtScriptedTaskTemplate< T >::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Fills in the task from the network buffer.

Implements DtScriptedTask.

template<class T>

virtual bool DtScriptedTaskTemplate< T >::init ( )

virtual

Initializer.

Implements DtScriptedTask.

template<class T>

virtual bool DtScriptedTaskTemplate< T >::setToNet ( )

virtual

Fills in the network buffer (created by base class simTask) with the task contents.

template<class T>

virtual char* DtScriptedTaskTemplate< T >::setToNet ( char *  )

virtual

Implements DtScriptedTask.

template<class T>

virtual DtRwVariableBindings& DtScriptedTaskTemplate< T >::variables ( )

virtual

Access to variables.

Implements DtScriptedTask.

template<class T>

virtual const DtRwVariableBindings& DtScriptedTaskTemplate< T >::variables ( ) const

virtual

Implements DtScriptedTask.

template<class T>

virtual void DtScriptedTaskTemplate< T >::setVariables ( const DtRwVariableBindings &  )

virtual

template<class T>

virtual DtRwVariableBindings& DtScriptedTaskTemplate< T >::variableDataTypes ( )

virtual

Access to the data types that represent the variables.

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

Implements DtScriptedTask.

template<class T>

virtual const DtRwVariableBindings& DtScriptedTaskTemplate< T >::variableDataTypes ( ) const

virtual

Implements DtScriptedTask.

template<class T>

virtual void DtScriptedTaskTemplate< T >::setScriptId ( const DtString &  )

virtual

Script to run.

Implements DtScriptedTask.

template<class T>

virtual const DtString& DtScriptedTaskTemplate< T >::scriptId ( ) const

virtual

Script id.

Implements DtScriptedTask.

template<class T>

virtual void DtScriptedTaskTemplate< T >::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  variableBindings = DtReaderWriter::nullVariableReference()  )

virtual

Override to upgrade scripted objects from nlength string list to nlength uuid list.

template<class T>

virtual void DtScriptedTaskTemplate< T >::getSelf ( const DtEnvironmentSP  , const DtEnvValueSP  root, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  bindings = DtVariableBindingsList()  )

virtual

template<class T>

virtual void DtScriptedTaskTemplate< T >::upgradeVariables ( )

protectedvirtual

Member Data Documentation

template<class T>

DtRwString DtScriptedTaskTemplate< T >::myScriptId

protected

template<class T>

DtRwVariableBindings DtScriptedTaskTemplate< T >::myVariables

protected

template<class T>

DtRwVariableBindings DtScriptedTaskTemplate< T >::myVariableDataTypes

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/scriptedTaskTask.h