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

#include <errors.h>

+ Inheritance diagram for PcpErrorTargetPathBase:

Public Member Functions

PCP_API ~PcpErrorTargetPathBase ()
 Destructor. More...
 
- Public Member Functions inherited from PcpErrorBase
virtual PCP_API ~PcpErrorBase ()
 Destructor. More...
 
virtual std::string ToString () const =0
 Converts error to string message. More...
 
bool ShouldReportAtMostOnce () const
 

Public Attributes

SdfPath targetPath
 The invalid target or connection path that was authored. More...
 
SdfPath owningPath
 The path to the property where the target was authored. More...
 
SdfSpecType ownerSpecType
 The spec type of the property where the target was authored. More...
 
SdfLayerHandle layer
 The layer containing the property where the target was authored. More...
 
SdfPath composedTargetPath
 
- Public Attributes inherited from PcpErrorBase
const TfEnum errorType
 The error code. More...
 
PcpSiteStr rootSite
 

Protected Member Functions

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

Detailed Description

Base class for composition errors related to target or connection paths.

Definition at line 467 of file errors.h.

Constructor & Destructor Documentation

PCP_API PcpErrorTargetPathBase::~PcpErrorTargetPathBase ( )

Destructor.

PcpErrorTargetPathBase::PcpErrorTargetPathBase ( TfEnum  errorType)
protected

Member Data Documentation

SdfPath PcpErrorTargetPathBase::composedTargetPath

The target or connection path in the composed scene. If this path could not be translated to the composed scene (e.g., in the case of an invalid external target path), this path will be empty.

Definition at line 485 of file errors.h.

SdfLayerHandle PcpErrorTargetPathBase::layer

The layer containing the property where the target was authored.

Definition at line 479 of file errors.h.

SdfSpecType PcpErrorTargetPathBase::ownerSpecType

The spec type of the property where the target was authored.

Definition at line 477 of file errors.h.

SdfPath PcpErrorTargetPathBase::owningPath

The path to the property where the target was authored.

Definition at line 475 of file errors.h.

SdfPath PcpErrorTargetPathBase::targetPath

The invalid target or connection path that was authored.

Definition at line 473 of file errors.h.


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