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

#include <errors.h>

+ Inheritance diagram for PcpErrorInvalidConflictingRelocation:

Public Types

enum  ConflictReason { ConflictReason::TargetIsConflictSource, ConflictReason::SourceIsConflictTarget, ConflictReason::TargetIsConflictSourceDescendant, ConflictReason::SourceIsConflictSourceDescendant }
 

Public Member Functions

PCP_API ~PcpErrorInvalidConflictingRelocation () 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
PcpErrorInvalidConflictingRelocationPtr 
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...
 
SdfPath conflictSourcePath
 The source path of the relocation this conflicts with. More...
 
SdfPath conflictTargetPath
 The target path of the relocation this conflicts with. More...
 
SdfLayerHandle conflictLayer
 The layer containing the authored relocation this conflicts with. More...
 
SdfPath conflictOwningPath
 The path to the prim where the relocation this conflicts with is authored. More...
 
ConflictReason conflictReason
 The reason the relocate is a conflict. 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

Relocation conflicts with another relocation in the layer stack.

Definition at line 762 of file errors.h.

Member Enumeration Documentation

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

Enumerator
TargetIsConflictSource 
SourceIsConflictTarget 
TargetIsConflictSourceDescendant 
SourceIsConflictSourceDescendant 

Definition at line 791 of file errors.h.

Constructor & Destructor Documentation

PCP_API PcpErrorInvalidConflictingRelocation::~PcpErrorInvalidConflictingRelocation ( )
override

Destructor.

Member Function Documentation

static PcpErrorInvalidConflictingRelocationPtr PcpErrorInvalidConflictingRelocation::New ( )
static

Returns a new error object.

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

Converts error to string message.

Implements PcpErrorBase.

Member Data Documentation

SdfLayerHandle PcpErrorInvalidConflictingRelocation::conflictLayer

The layer containing the authored relocation this conflicts with.

Definition at line 785 of file errors.h.

SdfPath PcpErrorInvalidConflictingRelocation::conflictOwningPath

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

Definition at line 787 of file errors.h.

ConflictReason PcpErrorInvalidConflictingRelocation::conflictReason

The reason the relocate is a conflict.

Definition at line 799 of file errors.h.

SdfPath PcpErrorInvalidConflictingRelocation::conflictSourcePath

The source path of the relocation this conflicts with.

Definition at line 781 of file errors.h.

SdfPath PcpErrorInvalidConflictingRelocation::conflictTargetPath

The target path of the relocation this conflicts with.

Definition at line 783 of file errors.h.

SdfLayerHandle PcpErrorInvalidConflictingRelocation::layer

The layer containing the authored relocates.

Definition at line 776 of file errors.h.

SdfPath PcpErrorInvalidConflictingRelocation::owningPath

The path to the prim where the relocates is authored.

Definition at line 778 of file errors.h.

SdfPath PcpErrorInvalidConflictingRelocation::sourcePath

The source path of the invalid relocation.

Definition at line 772 of file errors.h.

SdfPath PcpErrorInvalidConflictingRelocation::targetPath

The target path of the invalid relocation.

Definition at line 774 of file errors.h.


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