Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PcpErrorBase Class Referenceabstract

Base class for all error types. More...

#include <errors.h>

+ Inheritance diagram for PcpErrorBase:

Public Member Functions

virtual PCP_API ~PcpErrorBase ()
 Destructor.
 
virtual std::string ToString () const =0
 Converts error to string message.
 

Public Attributes

const PcpErrorType errorType
 The error code.
 
PcpSite rootSite
 The site of the composed prim or property being computed when the error was encountered.
 

Protected Member Functions

 PcpErrorBase (PcpErrorType errorType)
 Constructor.
 

Detailed Description

Base class for all error types.

Definition at line 87 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorBase()

virtual PCP_API ~PcpErrorBase ( )
virtual

Destructor.

◆ PcpErrorBase()

PcpErrorBase ( PcpErrorType  errorType)
explicitprotected

Constructor.

Member Function Documentation

◆ ToString()

virtual std::string ToString ( ) const
pure virtual

Converts error to string message.

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

Member Data Documentation

◆ errorType

const PcpErrorType errorType

The error code.

Definition at line 95 of file errors.h.

◆ rootSite

PcpSite 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 101 of file errors.h.

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