Loading...
Searching...
No Matches
PcpErrorArcToProhibitedChild Class Reference

Arcs that were not made between PcpNodes because the target is a prohibited child prim of its parent due to relocations. More...

#include <errors.h>

+ Inheritance diagram for PcpErrorArcToProhibitedChild:

Public Member Functions

PCP_API ~PcpErrorArcToProhibitedChild () override
 Destructor.
 
PCP_API std::string ToString () const override
 Converts error to string message.
 
- 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 PcpErrorArcToProhibitedChildPtr New ()
 Returns a new error object.
 

Public Attributes

PcpSite site
 The site where the invalid arc was expressed.
 
PcpSite targetSite
 The target site of the invalid arc which is a prohibited child.
 
PcpSite relocationSourceSite
 The site of the node under targetSite that is a relocation source in its layer stack.
 
PcpArcType arcType
 The type of arc.
 
- 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 PcpErrorBase
 PcpErrorBase (PcpErrorType errorType)
 Constructor.
 

Detailed Description

Arcs that were not made between PcpNodes because the target is a prohibited child prim of its parent due to relocations.

Definition at line 163 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorArcToProhibitedChild()

PCP_API ~PcpErrorArcToProhibitedChild ( )
override

Destructor.

Member Function Documentation

◆ New()

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

◆ arcType

PcpArcType arcType

The type of arc.

Definition at line 180 of file errors.h.

◆ relocationSourceSite

PcpSite relocationSourceSite

The site of the node under targetSite that is a relocation source in its layer stack.

Definition at line 178 of file errors.h.

◆ site

PcpSite site

The site where the invalid arc was expressed.

Definition at line 173 of file errors.h.

◆ targetSite

PcpSite targetSite

The target site of the invalid arc which is a prohibited child.

Definition at line 175 of file errors.h.


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