HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_AttributeTypes.h File Reference
#include <SYS/SYS_Types.h>
+ Include dependency graph for PDG_AttributeTypes.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  PDG_AttributeType : uint8 {
  PDG_AttributeType::eIntegerArray, PDG_AttributeType::eFloatArray, PDG_AttributeType::eStringArray, PDG_AttributeType::eFileArray,
  PDG_AttributeType::ePythonObject, PDG_AttributeType::eGeometry, PDG_AttributeType::eUndefined
}
 Enumeration of possible attribute types. More...
 
enum  PDG_AttributeFlag : uint16 {
  PDG_AttributeFlag::eNoFlags = 0x0000, PDG_AttributeFlag::eNoCopyFlag = 0x0001, PDG_AttributeFlag::eEnvExportFlag = 0x0002, PDG_AttributeFlag::eReadOnlyFlag = 0x0004,
  PDG_AttributeFlag::eInternalFlag = 0x0008, PDG_AttributeFlag::eOperatorFlag = 0x0010, PDG_AttributeFlag::eTransferFlag = 0x0020, PDG_AttributeFlag::eDependentFlag = 0x0040,
  PDG_AttributeFlag::eNoDirtyFlag = 0x0080, PDG_AttributeFlag::eTransientFlag = 0x0100, PDG_AttributeFlag::eBoundFlag = 0x0200, PDG_AttributeFlag::eInputFileFlag = 0x0400,
  PDG_AttributeFlag::eAllFlags = 0xFFFF
}
 Enumeration of extra attribute flags. Flags can be ORed together. More...
 
enum  PDG_AttributeCast {
  PDG_AttributeCast::eSuccess, PDG_AttributeCast::eErrorMissing, PDG_AttributeCast::eErrorType, PDG_AttributeCast::eErrorBounds,
  PDG_AttributeCast::eErrorTag
}
 Enumeration of attribute cast results. More...
 
enum  PDG_AttributeMergeOp {
  PDG_AttributeMergeOp::eIgnore, PDG_AttributeMergeOp::eFirstValue, PDG_AttributeMergeOp::eLastValue, PDG_AttributeMergeOp::eUniqueValues,
  PDG_AttributeMergeOp::eAppendArray, PDG_AttributeMergeOp::eMinimum, PDG_AttributeMergeOp::eMaximum, PDG_AttributeMergeOp::eSum,
  PDG_AttributeMergeOp::eAverage, PDG_AttributeMergeOp::eMode, PDG_AttributeMergeOp::eMedian, PDG_AttributeMergeOp::eSorted
}
 Enumeration of different ways that attributes can be combined. More...
 
enum  PDG_AttributeMergeError { PDG_AttributeMergeError::eNone, PDG_AttributeMergeError::eType, PDG_AttributeMergeError::eInvalidOp, PDG_AttributeMergeError::eStride }
 Enumerations of errors that can occur when merging attributes. More...
 
enum  PDG_AttributeIntrinsic {
  PDG_AttributeIntrinsic::eIndexAttrib, PDG_AttributeIntrinsic::eFrameAttrib, PDG_AttributeIntrinsic::eLoopDepthAttrib, PDG_AttributeIntrinsic::eIdAttrib,
  PDG_AttributeIntrinsic::eInputSizeAttrib, PDG_AttributeIntrinsic::eOutputSizeAttrib, PDG_AttributeIntrinsic::eNameAttrib, PDG_AttributeIntrinsic::eLabelAttrib,
  PDG_AttributeIntrinsic::eLogAttrib, PDG_AttributeIntrinsic::eInputAttrib, PDG_AttributeIntrinsic::eInputTagAttrib, PDG_AttributeIntrinsic::eOutputAttrib,
  PDG_AttributeIntrinsic::eOutputTagAttrib, PDG_AttributeIntrinsic::eSchedulerName, PDG_AttributeIntrinsic::eNodeName, PDG_AttributeIntrinsic::eCustomAttrib
}
 Enumeration of types of attribute that can be queried from work items. More...
 

Enumeration Type Documentation

enum PDG_AttributeCast
strong

Enumeration of attribute cast results.

Enumerator
eSuccess 

No cast error occured (success)

eErrorMissing 

Cast failed due to a missing/undefined attribute.

eErrorType 

Cast failed due to a type mismatch (string vs. int)

eErrorBounds 

Cast failed due to an index being out of bounds.

eErrorTag 

Cast failed due to an invalid tag (applies to files only)

Definition at line 90 of file PDG_AttributeTypes.h.

enum PDG_AttributeFlag : uint16
strong

Enumeration of extra attribute flags. Flags can be ORed together.

Enumerator
eNoFlags 

Covenience value, all flags off.

eNoCopyFlag 

The attribute should not be copied onto downstream work items.

eEnvExportFlag 

The attribute's value should be exported to the job environment.

eReadOnlyFlag 

The attribute is read-only and cannot be modified on this work item.

eInternalFlag 

The attribute is for internal use, and will be accessed with other API methods. It should not be displayed in the UI

eOperatorFlag 

The attribute contains a operator path.

eTransferFlag 

The attribute contains a path that should be transfered to remote machines when the work item cooks.

eDependentFlag 

The attribute should be copied to internal dependent(s) within the node, before the dependent(s) cooks

eNoDirtyFlag 

The attribute should not cause the owner to be dirtied if it changes between cooks, e.g due to work item regeneration

eTransientFlag 

The attribute is not saved when the owner is serialized.

eBoundFlag 

The attribute is bound to a particular work item. This flag is only relevant for global/graph attributes

eInputFileFlag 

The attribute should be treated as an extra input. If the file changes on disk between cooks, the cache of the work items using the file is invalided.

eAllFlags 

Definition at line 40 of file PDG_AttributeTypes.h.

Enumeration of types of attribute that can be queried from work items.

Enumerator
eIndexAttrib 

Index [numeric, string].

eFrameAttrib 

Frame [numeric, string].

eLoopDepthAttrib 

Loop depth [numeric, string].

eIdAttrib 

Work item unique id [numeric, string].

eInputSizeAttrib 

Input result list size [numeric, string].

eOutputSizeAttrib 
eNameAttrib 

Name [string].

eLabelAttrib 

Label [string].

eLogAttrib 

Log path [string].

eInputAttrib 

Input result list [string].

eInputTagAttrib 

Input tag [string].

eOutputAttrib 

Output result list [string].

eOutputTagAttrib 

Output tag [string].

eSchedulerName 

Scheduler name [string].

eNodeName 

Node name [string].

eCustomAttrib 

Custom attribute name [numeric, string].

Definition at line 168 of file PDG_AttributeTypes.h.

Enumerations of errors that can occur when merging attributes.

Enumerator
eNone 

No error occured.

eType 

Mismatch between types.

eInvalidOp 

Invalid merge operation for the attribute type.

eStride 

Mismatch between stride lengths.

Definition at line 152 of file PDG_AttributeTypes.h.

enum PDG_AttributeMergeOp
strong

Enumeration of different ways that attributes can be combined.

Enumerator
eIgnore 

The attribute should be excluded as it does not match any of the patterns in the map

eFirstValue 

The attribute is flattened, i.e. the first value for the attrib is used an no other values are selected.

eLastValue 

The attribute overwrites existing values, unless the destination has its own modications

eUniqueValues 

The unique values for the attribute are kept,.

eAppendArray 

The attribute values are concatenated together into an array.

eMinimum 

The minimum value is kept.

eMaximum 

The maximum value is kept.

eSum 

The sum of the values is kept.

eAverage 

The attribute values are averaged.

eMode 

The most common value is kept.

eMedian 

The middle value is kept.

eSorted 

The values are kept in sorted order.

Definition at line 109 of file PDG_AttributeTypes.h.

enum PDG_AttributeType : uint8
strong

Enumeration of possible attribute types.

Enumerator
eIntegerArray 

An array of int values.

eFloatArray 

An array of fpreal values.

eStringArray 

An array of UT_StringHolder values.

eFileArray 

An array of PDG_File values, e.g. File info structs.

ePythonObject 

A single, opaque PyObject.

eGeometry 

A single PDG_ApplicationShim::Geometry instance.

eUndefined 

Undefined or uninitialized attribute type.

Definition at line 15 of file PDG_AttributeTypes.h.