DtTaskExecutionRules Class Reference

This RW class contains the rules for executing tasks on a particular type of entity. More...

Inheritance diagram for DtTaskExecutionRules:

List of all members.

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)
	assignment operator
virtual	~DtTaskExecutionRules ()
	destructor
virtual bool	allTasksExclusive () const
virtual void	setAllTasksExclusive (bool v)
virtual DtMutuallyExclusiveTaskGroupList &	mutuallyExclusiveTaskGroupList ()
virtual const DtMutuallyExclusiveTaskGroupList &	mutuallyExclusiveTaskGroupList () const
Protected Attributes
DtRwBoolean	myAllTasksExclusive
	Parameter Name: all-tasks-exclusive Parameter Description: Indicates whether all tasks are treated as mutually exclusive from each other or not.
DtMutuallyExclusiveTaskGroupList	myMutuallyExclusiveTaskGroupList
	Parameter Name: mutually-exclusive-task-groups Parameter Description: A list of task groups.

---

Detailed Description

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.

---

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 DtMutuallyExclusiveTaskGroupList& DtTaskExecutionRules::mutuallyExclusiveTaskGroupList

(

)

[virtual]

See also:

myMutuallyExclusiveTaskGroupList

virtual const DtMutuallyExclusiveTaskGroupList& DtTaskExecutionRules::mutuallyExclusiveTaskGroupList

(

)

const [virtual]

See also:

myMutuallyExclusiveTaskGroupList

---

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

---

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

• include/vrfobjparam/taskExecutionRules.h