HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PcpErrorBase Class Referenceabstract

#include <errors.h>

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

Public Attributes

const PcpErrorType errorType
 The error code. More...
 
PcpSite rootSite
 

Protected Member Functions

 PcpErrorBase (PcpErrorType errorType)
 Constructor. More...
 

Detailed Description

Base class for all error types.

Definition at line 84 of file errors.h.

Constructor & Destructor Documentation

virtual PCP_API PcpErrorBase::~PcpErrorBase ( )
virtual

Destructor.

PcpErrorBase::PcpErrorBase ( PcpErrorType  errorType)
explicitprotected

Constructor.

Member Function Documentation

virtual std::string PcpErrorBase::ToString ( ) const
pure virtual

Converts error to string message.

Implemented in PcpErrorVariableExpressionError, 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

const PcpErrorType PcpErrorBase::errorType

The error code.

Definition at line 92 of file errors.h.

PcpSite PcpErrorBase::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 98 of file errors.h.

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