All the information about a single suspended task. This information should be sufficient to resume the task.

Inheritance diagram for DtSuspendedTaskInfo:

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

virtual	~DtSuspendedTaskInfo ()

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

DtSuspendedTaskInfo &	operator= (const DtSuspendedTaskInfo &orig)

bool	operator== (const DtSuspendedTaskInfo &rhs)

bool	operator!= (const DtSuspendedTaskInfo &rhs)

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual DtSimTaskStatePtr	taskState ()

virtual void	setTaskState (DtSimTaskStatePtr taskState)

virtual DtSuspendedTaskInfoList &	subtaskStateList ()

virtual const DtSuspendedTaskInfoList &	subtaskStateList () const

virtual bool	topLevelTaskSuspended () const

virtual void	setTopLeveltaskSuspended (bool)

Public Member Functions inherited from DtTaskStatusEntry
	DtTaskStatusEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtTaskStatusEntry ()

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

DtTaskStatusEntry &	operator= (const DtTaskStatusEntry &orig)

virtual void	setControllerName (const DtString &name)

virtual const DtString &	controllerName () const

virtual void	setTaskMessage (const DtTaskMessage &taskMessage)

virtual DtTaskMessage *	taskMessage () const

virtual void	setTasked (bool flag)

virtual bool	tasked () const

virtual void	addPendingSubtaskId (int subtaskId)

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)

virtual const DtSubtaskStatusList &	subtaskStatusList () const

virtual DtSubtaskStatusList &	subtaskStatusList ()

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)

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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	wasUpdatedSince (DtTime t) 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
DtSimTaskStatePtr	myTaskState

DtSuspendedTaskInfoList	mySubtaskStateList

DtRwBoolean	myTopLevelTaskIsSuspended

Protected Attributes inherited from DtTaskStatusEntry
DtRwString	myControllerName

DtTaskMessageDescriptor	myTaskMessageDescriptor

DtRwBoolean	myTasked

DtSubtaskStatusList	mySubtaskStatusList

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

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

constructor

virtual DtSuspendedTaskInfo::~DtSuspendedTaskInfo ( )

virtual

destructor

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

copy constructor

Member Function Documentation

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

assignment operator

bool DtSuspendedTaskInfo::operator== ( const DtSuspendedTaskInfo & rhs )

inline

bool DtSuspendedTaskInfo::operator!= ( const DtSuspendedTaskInfo & rhs )

inline

References DtReaderWriter::operator==().

virtual void DtSuspendedTaskInfo::putSelf	(	std::string &	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtFilename::nullFilename()`
	)

virtual

Top level call to write itself to file. If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

virtual void DtSuspendedTaskInfo::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 from DtTaskStatusEntry.

virtual DtSimTaskStatePtr DtSuspendedTaskInfo::taskState ( )

virtual

virtual void DtSuspendedTaskInfo::setTaskState ( DtSimTaskStatePtr taskState )

virtual

virtual DtSuspendedTaskInfoList& DtSuspendedTaskInfo::subtaskStateList ( )

virtual

virtual const DtSuspendedTaskInfoList& DtSuspendedTaskInfo::subtaskStateList ( ) const

virtual

virtual bool DtSuspendedTaskInfo::topLevelTaskSuspended ( ) const

virtual

Whether the top level task referred to by this entry is suspended. It is possible for just the subclasses to be suspended, and not the top level task itself.

virtual void DtSuspendedTaskInfo::setTopLeveltaskSuspended ( bool )

virtual

Member Data Documentation

DtSimTaskStatePtr DtSuspendedTaskInfo::myTaskState

protected

DtSuspendedTaskInfoList DtSuspendedTaskInfo::mySubtaskStateList

protected

DtRwBoolean DtSuspendedTaskInfo::myTopLevelTaskIsSuspended

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation