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

#include <errors.h>

+ Inheritance diagram for PcpErrorArcToProhibitedChild:

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

PcpSite site
 The site where the invalid arc was expressed. More...
 
PcpSite targetSite
 The target site of the invalid arc which is a prohibited child. More...
 
PcpSite relocationSourceSite
 
PcpArcType arcType
 The type of arc. More...
 
- Public Attributes inherited from PcpErrorBase
const PcpErrorType errorType
 The error code. More...
 
PcpSite rootSite
 

Additional Inherited Members

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

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

PCP_API PcpErrorArcToProhibitedChild::~PcpErrorArcToProhibitedChild ( )
override

Destructor.

Member Function Documentation

static PcpErrorArcToProhibitedChildPtr PcpErrorArcToProhibitedChild::New ( )
static

Returns a new error object.

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

Converts error to string message.

Implements PcpErrorBase.

Member Data Documentation

PcpArcType PcpErrorArcToProhibitedChild::arcType

The type of arc.

Definition at line 180 of file errors.h.

PcpSite PcpErrorArcToProhibitedChild::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.

PcpSite PcpErrorArcToProhibitedChild::site

The site where the invalid arc was expressed.

Definition at line 173 of file errors.h.

PcpSite PcpErrorArcToProhibitedChild::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: