Instances of DtTaskStatusEntry hold the current tasking/subtasking state for a given component and can be saved to the OOB file. More...

Inheritance diagram for DtTaskStatusEntry:

[legend]

Public Member Functions
	DtTaskStatusEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtTaskStatusEntry ()
	destructor
	DtTaskStatusEntry (const DtString &name, const DtTaskStatusEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtTaskStatusEntry &	operator= (const DtTaskStatusEntry &orig)
	assignment operator
virtual void	setControllerName (const DtString &name)
	set/get name of the controller for which this status applies
virtual const DtString &	controllerName () const
virtual void	setTaskMessage (const DtTaskMessage &taskMessage)
	set/get task message
virtual DtTaskMessage *	taskMessage () const
virtual void	setTasked (bool flag)
	set/get is-tasked flag
virtual bool	tasked () const
virtual void	addPendingSubtaskId (int subtaskId)
	Functions to manipulate list of pending subtask Ids for this entry.
virtual void	removePendingSubtaskId (int subtaskId)
virtual bool	findPendingSubtaskId (int subtaskId) const
virtual const DtSubtaskStatusEntry *	findSubtaskStatus (int subtaskId) const
virtual DtSubtaskStatusEntry *	findSubtaskStatus (int subtaskId)
virtual void	removeAllPendingSubtaskIds ()
virtual void	printPendingSubtaskIds () const
virtual const DtSubtaskStatusList &	subtaskStatusList () const
virtual DtSubtaskStatusList &	subtaskStatusList ()
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Overridden to get pending-subtask-ids member from VRF 4.0.4 and earlier OOB files, and translate that data into mySubtaskStatusList.
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
DtRwString	myControllerName
DtTaskMessageDescriptor	myTaskMessageDescriptor
DtRwBoolean	myTasked
DtSubtaskStatusList	mySubtaskStatusList
	Holds status for all subtasks started by this 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

Instances of DtTaskStatusEntry hold the current tasking/subtasking state for a given component and can be saved to the OOB file.

Constructor & Destructor Documentation

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

constructor

virtual DtTaskStatusEntry::~DtTaskStatusEntry ( )

virtual

destructor

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

copy constructor

Member Function Documentation

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

assignment operator

virtual void DtTaskStatusEntry::setControllerName ( const DtString & name )

virtual

set/get name of the controller for which this status applies

virtual const DtString& DtTaskStatusEntry::controllerName ( ) const

virtual

virtual void DtTaskStatusEntry::setTaskMessage ( const DtTaskMessage & taskMessage )

virtual

set/get task message

virtual DtTaskMessage* DtTaskStatusEntry::taskMessage ( ) const

virtual

virtual void DtTaskStatusEntry::setTasked ( bool flag )

virtual

set/get is-tasked flag

virtual bool DtTaskStatusEntry::tasked ( ) const

virtual

virtual void DtTaskStatusEntry::addPendingSubtaskId ( int subtaskId )

virtual

Functions to manipulate list of pending subtask Ids for this entry.

virtual void DtTaskStatusEntry::removePendingSubtaskId ( int subtaskId )

virtual

virtual bool DtTaskStatusEntry::findPendingSubtaskId ( int subtaskId ) const

virtual

virtual const DtSubtaskStatusEntry* DtTaskStatusEntry::findSubtaskStatus ( int subtaskId ) const

virtual

virtual DtSubtaskStatusEntry* DtTaskStatusEntry::findSubtaskStatus ( int subtaskId )

virtual

virtual void DtTaskStatusEntry::removeAllPendingSubtaskIds ( )

virtual

virtual void DtTaskStatusEntry::printPendingSubtaskIds ( ) const

virtual

virtual const DtSubtaskStatusList& DtTaskStatusEntry::subtaskStatusList ( ) const

virtual

virtual DtSubtaskStatusList& DtTaskStatusEntry::subtaskStatusList ( )

virtual

virtual void DtTaskStatusEntry::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath = `DtFilename::nullFilename()`,
		const DtVariableBindingsList &	variableBindings = `nullVariableReference()`
	)

virtual

Overridden to get pending-subtask-ids member from VRF 4.0.4 and earlier OOB files, and translate that data into mySubtaskStatusList.

Reimplemented in DtSuspendedTaskInfo.

Member Data Documentation

DtRwString DtTaskStatusEntry::myControllerName

protected

DtTaskMessageDescriptor DtTaskStatusEntry::myTaskMessageDescriptor

protected

DtRwBoolean DtTaskStatusEntry::myTasked

protected

DtSubtaskStatusList DtTaskStatusEntry::mySubtaskStatusList

protected

Holds status for all subtasks started by this task.

This entry replaces the old (VRF 4.0.4) myPendingSubtaskIds.

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