HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PcpErrorInvalidAuthoredRelocation Class Reference

#include <errors.h>

+ Inheritance diagram for PcpErrorInvalidAuthoredRelocation:

Public Member Functions

PCP_API ~PcpErrorInvalidAuthoredRelocation () override
 Destructor. More...
 
PCP_API std::string ToString () const override
 Converts error to string message. More...
 
- Public Member Functions inherited from PcpErrorRelocationBase
PCP_API ~PcpErrorRelocationBase () override
 Destructor. More...
 
- Public Member Functions inherited from PcpErrorBase
virtual PCP_API ~PcpErrorBase ()
 Destructor. More...
 

Static Public Member Functions

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

Public Attributes

SdfPath sourcePath
 The source path of the invalid relocation. More...
 
SdfPath targetPath
 The target path of the invalid relocation. More...
 
SdfLayerHandle layer
 The layer containing the authored relocates. More...
 
SdfPath owningPath
 The path to the prim where the relocates is authored. More...
 
std::string messages
 Additional messages about the error. More...
 
- Public Attributes inherited from PcpErrorBase
const PcpErrorType errorType
 The error code. More...
 
PcpSite rootSite
 

Additional Inherited Members

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

Detailed Description

Invalid authored relocation found in a relocates field.

Definition at line 726 of file errors.h.

Constructor & Destructor Documentation

PCP_API PcpErrorInvalidAuthoredRelocation::~PcpErrorInvalidAuthoredRelocation ( )
override

Destructor.

Member Function Documentation

static PcpErrorInvalidAuthoredRelocationPtr PcpErrorInvalidAuthoredRelocation::New ( )
static

Returns a new error object.

PCP_API std::string PcpErrorInvalidAuthoredRelocation::ToString ( ) const
overridevirtual

Converts error to string message.

Implements PcpErrorBase.

Member Data Documentation

SdfLayerHandle PcpErrorInvalidAuthoredRelocation::layer

The layer containing the authored relocates.

Definition at line 740 of file errors.h.

std::string PcpErrorInvalidAuthoredRelocation::messages

Additional messages about the error.

Definition at line 745 of file errors.h.

SdfPath PcpErrorInvalidAuthoredRelocation::owningPath

The path to the prim where the relocates is authored.

Definition at line 742 of file errors.h.

SdfPath PcpErrorInvalidAuthoredRelocation::sourcePath

The source path of the invalid relocation.

Definition at line 736 of file errors.h.

SdfPath PcpErrorInvalidAuthoredRelocation::targetPath

The target path of the invalid relocation.

Definition at line 738 of file errors.h.


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