This is a DtReaderWriter subclass which holds the status of a subtask that was issues by another task, so that it can be checked periodically by the issuing task controller. More...

Inheritance diagram for DtSubtaskStatusEntry:

[legend]

Public Member Functions
	DtSubtaskStatusEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtSubtaskStatusEntry ()
	destructor
	DtSubtaskStatusEntry (const DtString &name, const DtSubtaskStatusEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
	DtSubtaskStatusEntry (const DtSubtaskStatusEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
DtSubtaskStatusEntry &	operator= (const DtSubtaskStatusEntry &orig)
	assignment operator

virtual void	setTaskId (int id)
virtual int	taskId () const

virtual void	setComplete (bool v)
virtual bool	complete () const

virtual void	setResult (bool v)
virtual bool	result () const

virtual void	setCanceled (bool v)
virtual bool	canceled () const

virtual void	setExecutingEntity (const DtString &entityName)
virtual DtString	executingEntity () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
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.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
DtRwInt	myTaskId
	The ID value which the subtask was started with.
DtRwBoolean	myComplete
	Indicates whether a task-complete-report has been received for this subtask or not.
DtRwBoolean	myResult
	Once myComplete is true, this holds the success flag that was received in the task complete report.
DtRwBoolean	myCanceled
	Set to true if the task was canceled (i.e. replaced by another task)
DtRwString	myExecutingEntity
	For tasks that are issued to other entities, and tracked in the subtask status list, this holds the name of the entity executing the task.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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

Detailed Description

This is a DtReaderWriter subclass which holds the status of a subtask that was issues by another task, so that it can be checked periodically by the issuing task controller.

Constructor & Destructor Documentation

DtSubtaskStatusEntry::DtSubtaskStatusEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

virtual DtSubtaskStatusEntry::~DtSubtaskStatusEntry ( )

virtual

destructor

DtSubtaskStatusEntry::DtSubtaskStatusEntry	(	const DtString &	name,
		const DtSubtaskStatusEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

DtSubtaskStatusEntry::DtSubtaskStatusEntry	(	const DtSubtaskStatusEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Member Function Documentation

DtSubtaskStatusEntry& DtSubtaskStatusEntry::operator= ( const DtSubtaskStatusEntry & orig )

assignment operator

virtual void DtSubtaskStatusEntry::setTaskId ( int id )

virtual

See Also: myTaskId

virtual int DtSubtaskStatusEntry::taskId ( ) const

virtual

See Also: myTaskId

virtual void DtSubtaskStatusEntry::setComplete ( bool v )

virtual

See Also: #myCompete

virtual bool DtSubtaskStatusEntry::complete ( ) const

virtual

See Also: #myCompete

virtual void DtSubtaskStatusEntry::setResult ( bool v )

virtual

See Also: myResult

virtual bool DtSubtaskStatusEntry::result ( ) const

virtual

See Also: myResult

virtual void DtSubtaskStatusEntry::setCanceled ( bool v )

virtual

See Also: myCanceled

virtual bool DtSubtaskStatusEntry::canceled ( ) const

virtual

See Also: myCanceled

virtual void DtSubtaskStatusEntry::setExecutingEntity ( const DtString & entityName )

virtual

See Also: myExecutingEntity

virtual DtString DtSubtaskStatusEntry::executingEntity ( ) const

virtual

See Also: myExecutingEntity

Member Data Documentation

DtRwInt DtSubtaskStatusEntry::myTaskId

protected

The ID value which the subtask was started with.

DtRwBoolean DtSubtaskStatusEntry::myComplete

protected

Indicates whether a task-complete-report has been received for this subtask or not.

DtRwBoolean DtSubtaskStatusEntry::myResult

protected

Once myComplete is true, this holds the success flag that was received in the task complete report.

This value is not valid until myComplete is true.

DtRwBoolean DtSubtaskStatusEntry::myCanceled

protected

Set to true if the task was canceled (i.e. replaced by another task)

DtRwString DtSubtaskStatusEntry::myExecutingEntity

protected

For tasks that are issued to other entities, and tracked in the subtask status list, this holds the name of the entity executing the task.

For local subtasks, this is an empty string.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/taskStatusEntry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation