All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PcpPrimIndexOutputs Class Reference

Outputs of the prim indexing procedure. More...

Public Types

enum  PayloadState {
  NoPayload, IncludedByIncludeSet, ExcludedByIncludeSet, IncludedByPredicate,
  ExcludedByPredicate
}
 Enumerator whose enumerants describe the payload state of this prim index. More...
 

Public Member Functions

void swap (PcpPrimIndexOutputs &r)
 Swap content with r. More...
 
PcpNodeRef Append (PcpPrimIndexOutputs &&childOutputs, const PcpArc &arcToParent, PcpErrorBasePtr *error)
 Appends the outputs from childOutputs to this object, using arcToParent to connect childOutputs' prim index to this object's prim index. More...
 

Public Attributes

PcpPrimIndex primIndex
 Prim index describing the composition structure for the associated prim. More...
 
PcpErrorVector allErrors
 List of all errors encountered during indexing. More...
 
PayloadState payloadState = NoPayload
 Indicates the payload state of this index. More...
 
PcpDynamicFileFormatDependencyData dynamicFileFormatDependency
 A list of names of fields that were composed to generate dynamic file format arguments for a node in primIndex. More...
 

Detailed Description

Outputs of the prim indexing procedure.

Definition at line 276 of file primIndex.h.

Member Enumeration Documentation

Enumerator whose enumerants describe the payload state of this prim index.

NoPayload if the index has no payload arcs, otherwise whether payloads were included or excluded, and if done so by consulting either the cache's payload include set, or determined by a payload predicate.

Definition at line 283 of file primIndex.h.

Member Function Documentation

PcpNodeRef Append ( PcpPrimIndexOutputs &&  childOutputs,
const PcpArc arcToParent,
PcpErrorBasePtr *  error 
)

Appends the outputs from childOutputs to this object, using arcToParent to connect childOutputs' prim index to this object's prim index.

Returns the node in this object's prim index corresponding to the root node of childOutputs' prim index.

void swap ( PcpPrimIndexOutputs r)
inline

Swap content with r.

Definition at line 305 of file primIndex.h.

Member Data Documentation

PcpErrorVector allErrors

List of all errors encountered during indexing.

Definition at line 292 of file primIndex.h.

PcpDynamicFileFormatDependencyData dynamicFileFormatDependency

A list of names of fields that were composed to generate dynamic file format arguments for a node in primIndex.

These are not necessarily fields that had values, but is the list of all fields that a composed value was requested for.

Definition at line 302 of file primIndex.h.

PayloadState payloadState = NoPayload

Indicates the payload state of this index.

See documentation for PayloadState enum for more information.

Definition at line 296 of file primIndex.h.

PcpPrimIndex primIndex

Prim index describing the composition structure for the associated prim.

Definition at line 289 of file primIndex.h.


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