Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PcpErrorBase Class Referenceabstract

Base class for all error types. More...

+ Inheritance diagram for PcpErrorBase:

Public Member Functions

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

Public Attributes

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...
 

Protected Member Functions

 PcpErrorBase (TfEnum errorType)
 Constructor. More...
 

Detailed Description

Base class for all error types.

Definition at line 88 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorBase()

virtual PCP_API ~PcpErrorBase ( )
virtual

Destructor.

◆ PcpErrorBase()

PcpErrorBase ( TfEnum  errorType)
protected

Constructor.

Member Function Documentation

◆ ShouldReportAtMostOnce()

bool ShouldReportAtMostOnce ( ) const
inline

Return true if this type of error should be reported at most once for a given prim.

Definition at line 106 of file errors.h.

◆ ToString()

virtual std::string ToString ( ) const
pure virtual

Converts error to string message.

Implemented in PcpErrorUnresolvedPrimPath, PcpErrorTargetPermissionDenied, PcpErrorSublayerCycle, PcpErrorPropertyPermissionDenied, PcpErrorPrimPermissionDenied, PcpErrorOpinionAtRelocationSource, PcpErrorInvalidSublayerPath, PcpErrorInvalidSublayerOwnership, PcpErrorInvalidReferenceOffset, PcpErrorInvalidSublayerOffset, PcpErrorInvalidTargetPath, PcpErrorInvalidExternalTargetPath, PcpErrorInvalidInstanceTargetPath, PcpErrorMutedAssetPath, PcpErrorInvalidAssetPath, PcpErrorInvalidPrimPath, PcpErrorInconsistentAttributeVariability, PcpErrorInconsistentAttributeType, PcpErrorInconsistentPropertyType, PcpErrorCapacityExceeded, PcpErrorArcPermissionDenied, and PcpErrorArcCycle.

Member Data Documentation

◆ errorType

const TfEnum errorType

The error code.

Definition at line 96 of file errors.h.

◆ rootSite

PcpSiteStr rootSite

The site of the composed prim or property being computed when the error was encountered.

(Note that some error types contain an additional site to capture more specific information about the site of the error.)

Definition at line 102 of file errors.h.

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