DtUserTask Class Reference

class DtUserTask:

Instances of DtUserTask are tasks defined by the user. The parameters for the task are stored as a list of strings.

DtUserTask is a specialized task that acts as a container for a user-defined task. There is no inherent action associated with a user task. It is generic task shell, meant to be used to convey the data associated with a new kind of task. It contains a number of generic string parameters, which the user uses to specify a name for the new task type, and any parameters neces- sary to fully describe the task. The user task can be used from within a plan, as you would any other task. It can also be configured through the GUI in the same way you would normally configure tasks.

task-type: DtUserTaskType

parameters: user task name - A unique string name identifying the specific user task. The name can be used in the components that register for DtUserTask messages to identify the particular user-defined task.

generic string arguments [4] - A user task can use up to four text strings to store parameters for the task. It is up to the user to deter- mine the content of the parameters.

Inheritance diagram for DtUserTask:

Public Member Functions
	DtUserTask ()
	DtUserTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtUserTask () override
	DtUserTask (const DtString &writeName, const DtUserTask &orig, DtReaderWriterRegistry *parentRegistry=0)
DtUserTask &	operator= (const DtUserTask &orig)
virtual const DtSimTaskMessageType &	type () const override
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	stringRep () const override
virtual const DtString &	userTaskName () const
virtual void	setUserTaskName (const DtString &taskName)
virtual const DtString &	arg1Text () const
virtual void	setArg1Text (const DtString &value)
virtual const DtString &	arg2Text () const
virtual void	setArg2Text (const DtString &value)
virtual const DtString &	arg3Text () const
virtual void	setArg3Text (const DtString &value)
virtual const DtString &	arg4Text () const
virtual void	setArg4Text (const DtString &value)
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask () override
virtual bool	init ()
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
virtual bool	allowTaskVisualizations () const
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual char *	netRep ()
virtual bool	isOneClick () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwString	myUserTaskName
DtRwString	myArg1Text
DtRwString	myArg2Text
DtRwString	myArg3Text
DtRwString	myArg4Text
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
DtRwBoolean	myAllowTaskVisualizations
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimTask &	operator= (const DtSimTask &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtUserTask::DtUserTask

(

)

default constructor

DtUserTask::DtUserTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

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

virtual DtUserTask::~DtUserTask ( )

overridevirtual

destructor

DtUserTask::DtUserTask	(	const DtString &	writeName,
		const DtUserTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

Member Function Documentation

DtUserTask& DtUserTask::operator=

(

const DtUserTask &

orig

)

assignment operator

virtual const DtSimTaskMessageType& DtUserTask::type ( ) const

overridevirtual

Returns "user-defined-task".

Implements DtSimTask.

virtual DtSimTask* DtUserTask::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

overridevirtual

Creates a copy of this user-defined task.

Implements DtSimTask.

virtual DtString DtUserTask::stringRep ( ) const

overridevirtual

Returns a human-readable string representation of the task. This string representation is used to display information about the task in the plan editor and viewer. The type and parameters for the task are typically encoded in the string. The format of the string is up to you.

Implements DtSimTask.

static DtSimTask* DtUserTask::creator ( )

static

virtual const DtString& DtUserTask::userTaskName ( ) const

virtual

Set/get the name of the user-defined task.

virtual void DtUserTask::setUserTaskName ( const DtString &  taskName )

virtual

virtual const DtString& DtUserTask::arg1Text ( ) const

virtual

Set/get the 1st argument.

virtual void DtUserTask::setArg1Text ( const DtString &  value )

virtual

virtual const DtString& DtUserTask::arg2Text ( ) const

virtual

Set/get the 2nd argument.

virtual void DtUserTask::setArg2Text ( const DtString &  value )

virtual

virtual const DtString& DtUserTask::arg3Text ( ) const

virtual

Set/get the 3rd argument.

virtual void DtUserTask::setArg3Text ( const DtString &  value )

virtual

virtual const DtString& DtUserTask::arg4Text ( ) const

virtual

Set/get the 4th argument.

virtual void DtUserTask::setArg4Text ( const DtString &  value )

virtual

virtual int DtUserTask::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSimTask.

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

overridevirtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtUserTask::setToNet ( )

overridevirtual

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

Reimplemented from DtSimTask.

Member Data Documentation

DtRwString DtUserTask::myUserTaskName

protected

DtRwString DtUserTask::myArg1Text

protected

DtRwString DtUserTask::myArg2Text

protected

DtRwString DtUserTask::myArg3Text

protected

DtRwString DtUserTask::myArg4Text

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrftasks/userTask.h