PcpErrorInvalidPrimPath Class Reference

Invalid prim paths used by references or payloads. More...

+ Inheritance diagram for PcpErrorInvalidPrimPath:

Public Member Functions

PCP_API ~PcpErrorInvalidPrimPath ()
 Destructor. More...
 
virtual PCP_API std::string ToString () const
 Converts error to string message. More...
 
- Public Member Functions inherited from PcpErrorBase
virtual PCP_API ~PcpErrorBase ()
 Destructor. More...
 
bool ShouldReportAtMostOnce () const
 Return true if this type of error should be reported at most once for a given prim. More...
 

Static Public Member Functions

static PcpErrorInvalidPrimPathPtr New ()
 Returns a new error object. More...
 

Public Attributes

PcpSite site
 The site where the invalid arc was expressed. More...
 
SdfPath primPath
 The target prim path of the arc that is invalid. More...
 
SdfLayerHandle sourceLayer
 The source layer of the spec that caused this arc to be introduced. More...
 
PcpArcType arcType
 
- Public Attributes inherited from PcpErrorBase
const TfEnum errorType
 The error code. More...
 
PcpSiteStr rootSite
 The site of the composed prim or property being computed when the error was encountered. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PcpErrorBase
 PcpErrorBase (TfEnum errorType)
 Constructor. More...
 

Detailed Description

Invalid prim paths used by references or payloads.

Definition at line 329 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorInvalidPrimPath()

Destructor.

Member Function Documentation

◆ New()

static PcpErrorInvalidPrimPathPtr New ( )
static

Returns a new error object.

◆ ToString()

virtual PCP_API std::string ToString ( ) const
virtual

Converts error to string message.

Implements PcpErrorBase.

Member Data Documentation

◆ primPath

SdfPath primPath

The target prim path of the arc that is invalid.

Definition at line 342 of file errors.h.

◆ site

PcpSite site

The site where the invalid arc was expressed.

Definition at line 339 of file errors.h.

◆ sourceLayer

SdfLayerHandle sourceLayer

The source layer of the spec that caused this arc to be introduced.

This may be a sublayer of the site.

Definition at line 346 of file errors.h.


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