#include <PDG_WorkItemOptions.h>

Public Types
enum	CloneMode { eCloneDefault, eCloneAlways, eCloneNever }

Public Member Functions
	PDG_WorkItemOptions ()
	Default initialization. More...

	PDG_WorkItemOptions (const UT_StringHolder &name, int index)
	Simple name/index initialization. More...

int	getPriority () const

void	setPriority (int priority)

bool	isPrioritySet () const

Public Attributes
UT_StringHolder	myName

UT_StringHolder	myTypeName

const PDG_WorkItemArray *	myParentArray

PDG_WorkItemArray	myLocalParentArray

PDG_WorkItem *	myParent

const PDG_WorkItem *	myCloneTarget

int	myParentArrayOffset

int	myIndex

CloneMode	myCloneMode
	Clone behavior. More...

PDG_WorkItemCookType	myCookType
	Work item cook type. More...

int	myBatchSize
	Batch size, only used when Batch is true. More...

int	myBatchOffset
	Batch offset, only used when Batch is true. More...

bool	myBatch
	Indicates that this is a batch work item. More...

bool	myInProcess
	Indicates that this is an in-process work item. More...

bool	myIsNoGenerate
	Indicates that this item cannot be used for downstream generation. More...

bool	myPreserveDataType
	Indicates that the data type should be preserved when cloning. More...

bool	myCloneOutputFiles
	Indicates that output results should be copied when cloning. More...

bool	myIsServiceMode

bool	myIsPartialCook

bool	myIsDynamicBatch

Detailed Description

Options available to configure the construction of a PDG work item

Examples:: PDG/PDG_ProcessorRandom.C.

Definition at line 21 of file PDG_WorkItemOptions.h.

Member Enumeration Documentation

enum PDG_WorkItemOptions::CloneMode

Behavior that controls whether or not data is cloned when generating a work item from a parent item

Enumerator
eCloneDefault	Uses the work item data type to determine whether or not data should be cloned
eCloneAlways	Always clones the upstream data regardless of the data type's preference
eCloneNever	Never clones the data, regardless of the data type's preference

Definition at line 25 of file PDG_WorkItemOptions.h.

Constructor & Destructor Documentation

PDG_WorkItemOptions::PDG_WorkItemOptions ( )

inline

Default initialization.

Definition at line 41 of file PDG_WorkItemOptions.h.

PDG_WorkItemOptions::PDG_WorkItemOptions	(	const UT_StringHolder &	name,
		int	index
	)

inline

Simple name/index initialization.

Definition at line 47 of file PDG_WorkItemOptions.h.

Member Function Documentation

int PDG_WorkItemOptions::getPriority ( ) const

inline

The work item priority. By default it is 'unset' and will inherit the parent priority. setPriority will cause the priority to override that behavior. getPriority will return 0 when the value is unset.

Definition at line 107 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::isPrioritySet ( ) const

inline

Definition at line 111 of file PDG_WorkItemOptions.h.

void PDG_WorkItemOptions::setPriority ( int priority )

inline

Definition at line 109 of file PDG_WorkItemOptions.h.

Member Data Documentation

bool PDG_WorkItemOptions::myBatch

Indicates that this is a batch work item.

Definition at line 127 of file PDG_WorkItemOptions.h.

int PDG_WorkItemOptions::myBatchOffset

Batch offset, only used when Batch is true.

Definition at line 124 of file PDG_WorkItemOptions.h.

int PDG_WorkItemOptions::myBatchSize

Batch size, only used when Batch is true.

Definition at line 121 of file PDG_WorkItemOptions.h.

CloneMode PDG_WorkItemOptions::myCloneMode

Clone behavior.

Definition at line 115 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myCloneOutputFiles

Indicates that output results should be copied when cloning.

Examples:: PDG/PDG_ProcessorRandom.C.

Definition at line 139 of file PDG_WorkItemOptions.h.

const PDG_WorkItem* PDG_WorkItemOptions::myCloneTarget

The item from which data should be cloned. If this is null, defaults to the parent as computed by the workitem holder.

Definition at line 93 of file PDG_WorkItemOptions.h.

PDG_WorkItemCookType PDG_WorkItemOptions::myCookType

Work item cook type.

Definition at line 118 of file PDG_WorkItemOptions.h.

int PDG_WorkItemOptions::myIndex

The work items index. If this is < 0, the upstream item index is used

Examples:: PDG/PDG_ProcessorRandom.C.

Definition at line 102 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myInProcess

Indicates that this is an in-process work item.

Definition at line 130 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myIsDynamicBatch

Indicates whether or not a batch work item can dynamically add sub items while it cooks. Only used when Batch is true.

Definition at line 150 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myIsNoGenerate

Indicates that this item cannot be used for downstream generation.

Definition at line 133 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myIsPartialCook

Indicates whether or not the work item supports partial cooking of batches. Only used when Batch is true.

Definition at line 146 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myIsServiceMode

Definition at line 142 of file PDG_WorkItemOptions.h.

PDG_WorkItemArray PDG_WorkItemOptions::myLocalParentArray

A locally stored version of the parent array, when the more efficient reference-based version is not suitable.

Definition at line 85 of file PDG_WorkItemOptions.h.

UT_StringHolder PDG_WorkItemOptions::myName

The name of the work item. This field is no longer used as work items cannot have custom names.

Definition at line 73 of file PDG_WorkItemOptions.h.

PDG_WorkItem* PDG_WorkItemOptions::myParent

The parent item, only valid when generating static items when the parent is not already determined

Examples:: PDG/PDG_ProcessorRandom.C.

Definition at line 89 of file PDG_WorkItemOptions.h.

const PDG_WorkItemArray* PDG_WorkItemOptions::myParentArray

The parent array, used when generating static items with a batch to hook up dependencies between subitems and upstream items

Definition at line 81 of file PDG_WorkItemOptions.h.

int PDG_WorkItemOptions::myParentArrayOffset

The parent array offset, used when adding dependencies from the parent array. Batch sub item 0 goes with parent_array[parent_offset], and so forth.

Definition at line 98 of file PDG_WorkItemOptions.h.

bool PDG_WorkItemOptions::myPreserveDataType

Indicates that the data type should be preserved when cloning.

Examples:: PDG/PDG_ProcessorRandom.C.

Definition at line 136 of file PDG_WorkItemOptions.h.

UT_StringHolder PDG_WorkItemOptions::myTypeName

The name of the type name - if this is null/empty string, the node's default work item data type is used

Definition at line 77 of file PDG_WorkItemOptions.h.

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

PDG/PDG_WorkItemOptions.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation