This RW class contains the rules for executing tasks on a particular type of entity. It contains lists of tasks that are mutually exclusive, meaning that they cannot be run at the same time on the entity.

Inheritance diagram for DtTaskExecutionRules:

[legend]

Public Member Functions
	DtTaskExecutionRules (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtTaskExecutionRules (const DtString &name, const DtTaskExecutionRules &orig, DtReaderWriterRegistry *parentRegistry=NULL)

const DtTaskExecutionRules &	operator= (const DtTaskExecutionRules &orig)

virtual	~DtTaskExecutionRules ()

virtual const DtTaskGroup *	findTaskGroup (const DtString &name) const

virtual std::list< DtString >	findGroupsForTask (const DtString &taskName) const


virtual bool	allTasksExclusive () const

virtual void	setAllTasksExclusive (bool v)


virtual DtRwNLengthStringVector &	nonPlanInterruptableTasks ()

virtual const DtRwNLengthStringVector &	nonPlanInterruptableTasks () const


virtual DtMutuallyExclusiveTaskGroupList &	mutuallyExclusiveTaskGroupList ()

virtual const DtMutuallyExclusiveTaskGroupList &	mutuallyExclusiveTaskGroupList () 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
DtRwBoolean	myAllTasksExclusive

DtMutuallyExclusiveTaskGroupList	myMutuallyExclusiveTaskGroupList

DtRwNLengthStringVector	myNonPlanInterruptableTasks

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

DtTaskExecutionRules::DtTaskExecutionRules	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtTaskExecutionRules::DtTaskExecutionRules	(	const DtString &	name,
		const DtTaskExecutionRules &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtTaskExecutionRules::~DtTaskExecutionRules ( )

virtual

destructor

Member Function Documentation

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

assignment operator

virtual bool DtTaskExecutionRules::allTasksExclusive ( ) const

virtual

See Also: myAllTasksExclusive

virtual void DtTaskExecutionRules::setAllTasksExclusive ( bool v )

virtual

See Also: myAllTasksExclusive

virtual DtRwNLengthStringVector& DtTaskExecutionRules::nonPlanInterruptableTasks ( )

virtual

See Also: myNonPlanInterruptableTasks

virtual const DtRwNLengthStringVector& DtTaskExecutionRules::nonPlanInterruptableTasks ( ) const

virtual

See Also: myNonPlanInterruptableTasks

virtual DtMutuallyExclusiveTaskGroupList& DtTaskExecutionRules::mutuallyExclusiveTaskGroupList ( )

virtual

See Also: myMutuallyExclusiveTaskGroupList

virtual const DtMutuallyExclusiveTaskGroupList& DtTaskExecutionRules::mutuallyExclusiveTaskGroupList ( ) const

virtual

See Also: myMutuallyExclusiveTaskGroupList

virtual const DtTaskGroup* DtTaskExecutionRules::findTaskGroup ( const DtString & name ) const

virtual

Finds the named group in the list and returns it. If not found, returns NULL.

virtual std::list<DtString> DtTaskExecutionRules::findGroupsForTask ( const DtString & taskName ) const

virtual

Searches the groups for the specified task name, and returns the names of the groups that includes the named task, if any. If not found, returns an empty list.

Member Data Documentation

DtRwBoolean DtTaskExecutionRules::myAllTasksExclusive

protected

Parameter Name: all-tasks-exclusive Parameter Description: Indicates whether all tasks are treated as mutually exclusive from each other or not. If true, then only one top level task will be permitted at a time, and the mutually-exclusive-task-groups is ignored. When true, the task manager acts in the way it did in VRF 3.11 and earlier. Parameter Default Value: true.

DtMutuallyExclusiveTaskGroupList DtTaskExecutionRules::myMutuallyExclusiveTaskGroupList

protected

Parameter Name: mutually-exclusive-task-groups Parameter Description: A list of task groups. Each entry in the list is a list of string task types. Each entry in the list represents a set of task types that cannot be executed concurrently. Whenever a new task is started, any other running (top level) tasks that are in the same group as that task will be interrupted. A task may be part of any number of groups. Parameter Default Value: Empty.

DtRwNLengthStringVector DtTaskExecutionRules::myNonPlanInterruptableTasks

protected

Parameter Name: non-plan-interruptable-tasks Parameter Description: A list of tasks, that is issued, will not abandon the plan currently running. If the plan running is also running a task of the same type, that plan will be cancelled and the next step in the plan executed Parameter Default Value: Empty.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/taskExecutionRules.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation