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.

Inheritance diagram for DtSubtaskStatusEntry:

[legend]

Public Member Functions
	DtSubtaskStatusEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtSubtaskStatusEntry ()

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

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

DtSubtaskStatusEntry &	operator= (const DtSubtaskStatusEntry &orig)


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 DtUUID &entityName)

virtual DtSimObjectReference	executingEntity () 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	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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)

Protected Attributes
DtRwInt	myTaskId

DtRwBoolean	myComplete

DtRwBoolean	myResult

DtRwBoolean	myCanceled

DtRwSimObjectReference	myExecutingEntity

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

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 Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

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 DtUUID & entityName )

virtual

See Also: myExecutingEntity

virtual DtSimObjectReference 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)

DtRwSimObjectReference 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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/taskStatusEntry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation