Loading...
Searching...
No Matches
PcpErrorInvalidSameTargetRelocations Class Reference

Multiple relocations in the layer stack have the same target. More...

#include <errors.h>

+ Inheritance diagram for PcpErrorInvalidSameTargetRelocations:

Classes

struct  RelocationSource
 Info about each relocate source that has the same target path. More...
 

Public Member Functions

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

Static Public Member Functions

static PcpErrorInvalidSameTargetRelocationsPtr New ()
 Returns a new error object.
 

Public Attributes

SdfPath targetPath
 The target path of the multiple invalid relocations.
 
std::vector< RelocationSourcesources
 The sources of all relocates that relocate to the target path.
 
- Public Attributes inherited from PcpErrorBase
const PcpErrorType errorType
 The error code.
 
PcpSite rootSite
 The site of the composed prim or property being computed when the error was encountered.
 

Additional Inherited Members

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

Detailed Description

Multiple relocations in the layer stack have the same target.

Definition at line 796 of file errors.h.


Class Documentation

◆ PcpErrorInvalidSameTargetRelocations::RelocationSource

struct PcpErrorInvalidSameTargetRelocations::RelocationSource

Info about each relocate source that has the same target path.

Definition at line 809 of file errors.h.

Class Members
SdfLayerHandle layer The layer containing the authored relocates.
SdfPath owningPath The path to the prim where the relocates is authored.
SdfPath sourcePath The source path of the invalid relocation.

Constructor & Destructor Documentation

◆ ~PcpErrorInvalidSameTargetRelocations()

PCP_API ~PcpErrorInvalidSameTargetRelocations ( )
override

Destructor.

Member Function Documentation

◆ New()

static PcpErrorInvalidSameTargetRelocationsPtr New ( )
static

Returns a new error object.

◆ ToString()

PCP_API std::string ToString ( ) const
overridevirtual

Converts error to string message.

Implements PcpErrorBase.

Member Data Documentation

◆ sources

std::vector<RelocationSource> sources

The sources of all relocates that relocate to the target path.

Definition at line 819 of file errors.h.

◆ targetPath

SdfPath targetPath

The target path of the multiple invalid relocations.

Definition at line 806 of file errors.h.


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