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

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
	Return true if this type of error should be reported at most once for a given prim. More...

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
	The target or connection path in the composed scene. More...

Public Attributes inherited from PcpErrorBase
const TfEnum	errorType
	The error code. More...

PcpSiteStr	rootSite
	The site of the composed prim or property being computed when the error was encountered. More...

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 454 of file errors.h.

Constructor & Destructor Documentation

PCP_API ~PcpErrorTargetPathBase ( )

Destructor.

SdfPath 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 472 of file errors.h.

SdfLayerHandle layer

The layer containing the property where the target was authored.

Definition at line 466 of file errors.h.

SdfSpecType ownerSpecType

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

Definition at line 464 of file errors.h.

SdfPath owningPath

The path to the property where the target was authored.

Definition at line 462 of file errors.h.

SdfPath targetPath

The invalid target or connection path that was authored.

Definition at line 460 of file errors.h.

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