Loading...
Searching...
No Matches
PcpPrimIndexOutputs Class Reference

Outputs of the prim indexing procedure. More...

#include <primIndex.h>

Public Types

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

Public Member Functions

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.
 

Public Attributes

PcpPrimIndex primIndex
 Prim index describing the composition structure for the associated prim.
 
PcpErrorVector allErrors
 List of all errors encountered during indexing.
 
PayloadState payloadState = NoPayload
 Indicates the payload state of this index.
 
PcpDynamicFileFormatDependencyData dynamicFileFormatDependency
 A list of names of fields that were composed to generate dynamic file format arguments for a node in primIndex.
 
PcpExpressionVariablesDependencyData expressionVariablesDependency
 Dependencies on expression variables from composition arcs in this prim index.
 
std::vector< PcpCulledDependencyculledDependencies
 Site dependencies from nodes in the prim index that have been culled.
 

Detailed Description

Outputs of the prim indexing procedure.

Definition at line 299 of file primIndex.h.

Member Enumeration Documentation

◆ PayloadState

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 306 of file primIndex.h.

Member Function Documentation

◆ Append()

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.

Member Data Documentation

◆ allErrors

PcpErrorVector allErrors

List of all errors encountered during indexing.

Definition at line 315 of file primIndex.h.

◆ culledDependencies

std::vector<PcpCulledDependency> culledDependencies

Site dependencies from nodes in the prim index that have been culled.

Definition at line 332 of file primIndex.h.

◆ dynamicFileFormatDependency

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 325 of file primIndex.h.

◆ expressionVariablesDependency

PcpExpressionVariablesDependencyData expressionVariablesDependency

Dependencies on expression variables from composition arcs in this prim index.

Definition at line 329 of file primIndex.h.

◆ payloadState

PayloadState payloadState = NoPayload

Indicates the payload state of this index.

See documentation for PayloadState enum for more information.

Definition at line 319 of file primIndex.h.

◆ primIndex

PcpPrimIndex primIndex

Prim index describing the composition structure for the associated prim.

Definition at line 312 of file primIndex.h.


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