DtUserTask Class Reference

class DtUserTask: More...

Inheritance diagram for DtUserTask:

Public Member Functions
	DtUserTask ()
	default constructor More...
	DtUserTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task. More...
virtual	~DtUserTask ()
	destructor More...
	DtUserTask (const DtString &writeName, const DtUserTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...
DtUserTask &	operator= (const DtUserTask &orig)
	assignment operator More...
virtual const DtSimTaskMessageType &	type () const
	Returns "user-defined-task". More...
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this user-defined task. More...
virtual DtString	stringRep () const
	Returns a human-readable string representation of the task. More...
virtual const DtString &	userTaskName () const
	Set/get the name of the user-defined task. More...
virtual void	setUserTaskName (const DtString &taskName)
virtual const DtString &	arg1Text () const
	Set/get the 1st argument. More...
virtual void	setArg1Text (const DtString &value)
virtual const DtString &	arg2Text () const
	Set/get the 2nd argument. More...
virtual void	setArg2Text (const DtString &value)
virtual const DtString &	arg3Text () const
	Set/get the 3rd argument. More...
virtual void	setArg3Text (const DtString &value)
virtual const DtString &	arg4Text () const
	Set/get the 4th argument. More...
virtual void	setArg4Text (const DtString &value)
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary. More...
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer. More...
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents. More...
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
	destructor More...
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation. More...
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
	If true, this task is a subtask. More...
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
	If true, this task is allowed to display its task visualizations. More...
virtual bool	allowTaskVisualizations () const
virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class. More...
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored. More...
virtual char *	netRep ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag. More...
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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())
	Gets data from the environment value. More...
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
	Static functions. More...
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
	Adds a task creator member function to the task factory. More...
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 ()
	The type that is used when archiving to an XML stream. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

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
	Container for the aliases which represent alternative names for the object. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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 ()
	Constructors are protected because no one should instantiate the base class, just derived versions. More...
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the write name will preface the task. More...
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...
const DtSimTask &	operator= (const DtSimTask &orig)
	assignment operator; same as copy constructor More...
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...
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

Detailed Description

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.

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 ( )

virtual

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

virtual

Returns "user-defined-task".

Implements DtSimTask.

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

virtual

Creates a copy of this user-defined task.

Implements DtSimTask.

virtual DtString DtUserTask::stringRep ( ) const

virtual

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

virtual

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  )

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtUserTask::setToNet ( )

virtual

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.vrf4-10-branch/include/vrftasks/userTask.h