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 void	removeInactiveSubtaskStatus (int olderThanTaskId=-1)
	Removes all subtask status entries that are either canceled or complete.
virtual const DtSubtaskStatusList &	subtaskStatusList () const
virtual DtSubtaskStatusList &	subtaskStatusList ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), 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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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.
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 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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

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
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.
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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
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.
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 void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

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 void DtTaskStatusEntry::removeInactiveSubtaskStatus ( int olderThanTaskId = -1 )

virtual

Removes all subtask status entries that are either canceled or complete.

Status for these task will no longer be available.

Parameters

olderThanTaskId If specified as a positive number, then only tasks with ID less than the specified value are cleared.

virtual const DtSubtaskStatusList& DtTaskStatusEntry::subtaskStatusList ( ) const

virtual

virtual DtSubtaskStatusList& DtTaskStatusEntry::subtaskStatusList ( )

virtual

virtual void DtTaskStatusEntry::getSelf	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths = `DtReaderWriter::SearchPaths()`,
		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