Loading...
Searching...
No Matches
PcpErrorInvalidConflictingRelocation Class Reference

Relocation conflicts with another relocation in the layer stack. More...

#include <errors.h>

+ Inheritance diagram for PcpErrorInvalidConflictingRelocation:

Public Types

enum class  ConflictReason { TargetIsConflictSource , SourceIsConflictTarget , TargetIsConflictSourceDescendant , SourceIsConflictSourceDescendant }
 Enumeration of reasons a relocate can be in conflict with another relocate. More...
 

Public Member Functions

PCP_API ~PcpErrorInvalidConflictingRelocation () 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 PcpErrorInvalidConflictingRelocationPtr New ()
 Returns a new error object.
 

Public Attributes

SdfPath sourcePath
 The source path of the invalid relocation.
 
SdfPath targetPath
 The target path of the invalid relocation.
 
SdfLayerHandle layer
 The layer containing the authored relocates.
 
SdfPath owningPath
 The path to the prim where the relocates is authored.
 
SdfPath conflictSourcePath
 The source path of the relocation this conflicts with.
 
SdfPath conflictTargetPath
 The target path of the relocation this conflicts with.
 
SdfLayerHandle conflictLayer
 The layer containing the authored relocation this conflicts with.
 
SdfPath conflictOwningPath
 The path to the prim where the relocation this conflicts with is authored.
 
ConflictReason conflictReason
 The reason the relocate is a conflict.
 
- 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

Relocation conflicts with another relocation in the layer stack.

Definition at line 742 of file errors.h.

Member Enumeration Documentation

◆ ConflictReason

enum class ConflictReason
strong

Enumeration of reasons a relocate can be in conflict with another relocate.

Definition at line 771 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorInvalidConflictingRelocation()

PCP_API ~PcpErrorInvalidConflictingRelocation ( )
override

Destructor.

Member Function Documentation

◆ New()

static PcpErrorInvalidConflictingRelocationPtr 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

◆ conflictLayer

SdfLayerHandle conflictLayer

The layer containing the authored relocation this conflicts with.

Definition at line 765 of file errors.h.

◆ conflictOwningPath

SdfPath conflictOwningPath

The path to the prim where the relocation this conflicts with is authored.

Definition at line 767 of file errors.h.

◆ conflictReason

ConflictReason conflictReason

The reason the relocate is a conflict.

Definition at line 779 of file errors.h.

◆ conflictSourcePath

SdfPath conflictSourcePath

The source path of the relocation this conflicts with.

Definition at line 761 of file errors.h.

◆ conflictTargetPath

SdfPath conflictTargetPath

The target path of the relocation this conflicts with.

Definition at line 763 of file errors.h.

◆ layer

SdfLayerHandle layer

The layer containing the authored relocates.

Definition at line 756 of file errors.h.

◆ owningPath

SdfPath owningPath

The path to the prim where the relocates is authored.

Definition at line 758 of file errors.h.

◆ sourcePath

SdfPath sourcePath

The source path of the invalid relocation.

Definition at line 752 of file errors.h.

◆ targetPath

SdfPath targetPath

The target path of the invalid relocation.

Definition at line 754 of file errors.h.


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