HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
errors.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_USD_PCP_ERRORS_H
25 #define PXR_USD_PCP_ERRORS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/pcp/api.h"
29 #include "pxr/usd/pcp/site.h"
30 #include "pxr/usd/pcp/types.h"
31 #include "pxr/usd/sdf/layer.h"
33 #include "pxr/usd/sdf/path.h"
34 
35 #include <memory>
36 #include <string>
37 #include <vector>
38 
40 
41 /// \enum PcpErrorType
42 ///
43 /// Enum to indicate the type represented by a Pcp error.
44 ///
73 };
74 
75 // Forward declarations:
77 typedef std::shared_ptr<PcpErrorBase> PcpErrorBasePtr;
78 typedef std::vector<PcpErrorBasePtr> PcpErrorVector;
79 
80 /// \class PcpErrorBase
81 ///
82 /// Base class for all error types.
83 ///
84 class PcpErrorBase {
85 public:
86  /// Destructor.
87  PCP_API virtual ~PcpErrorBase();
88  /// Converts error to string message.
89  virtual std::string ToString() const = 0;
90 
91  /// The error code.
93 
94  /// The site of the composed prim or property being computed when
95  /// the error was encountered. (Note that some error types
96  /// contain an additional site to capture more specific information
97  /// about the site of the error.)
99 
100 protected:
101  /// Constructor.
103 };
104 
105 ///////////////////////////////////////////////////////////////////////////////
106 
107 // Forward declarations:
109 typedef std::shared_ptr<PcpErrorArcCycle> PcpErrorArcCyclePtr;
110 
111 /// \class PcpErrorArcCycle
112 ///
113 /// Arcs between PcpNodes that form a cycle.
114 ///
116 public:
117  /// Returns a new error object.
118  static PcpErrorArcCyclePtr New();
119  /// Destructor.
120  PCP_API ~PcpErrorArcCycle() override;
121  /// Converts error to string message.
122  PCP_API std::string ToString() const override;
123 
125 
126 private:
127  /// Constructor is private. Use New() instead.
129 };
130 
131 ///////////////////////////////////////////////////////////////////////////////
132 
133 // Forward declarations:
135 typedef std::shared_ptr<PcpErrorArcPermissionDenied>
137 
138 /// \class PcpErrorArcPermissionDenied
139 ///
140 /// Arcs that were not made between PcpNodes because of permission
141 /// restrictions.
142 ///
144 public:
145  /// Returns a new error object.
147  /// Destructor.
149  /// Converts error to string message.
150  PCP_API std::string ToString() const override;
151 
152  /// The site where the invalid arc was expressed.
154  /// The private, invalid target of the arc.
156  /// The type of arc.
158 
159 private:
160  /// Constructor is private. Use New() instead.
162 };
163 
164 ///////////////////////////////////////////////////////////////////////////////
165 
166 // Forward declarations:
168 typedef std::shared_ptr<PcpErrorCapacityExceeded> PcpErrorCapacityExceededPtr;
169 
170 /// \class PcpErrorCapacityExceeded
171 ///
172 /// Exceeded the capacity for composition arcs at a single site.
173 ///
175 public:
176  /// Returns a new error object.
178  /// Destructor.
180  /// Converts error to string message.
181  PCP_API std::string ToString() const override;
182 
183 private:
184  /// Constructor is private. Use New() instead.
186 };
187 
188 ///////////////////////////////////////////////////////////////////////////////
189 
191 public:
192  /// Destructor.
194 
195  /// The identifier of the layer with the defining property spec.
197  /// The path of the defining property spec.
199 
200  /// The identifier of the layer with the conflicting property spec.
202  /// The path of the conflicting property spec.
204 
205 protected:
206  /// Constructor.
208 };
209 
210 ///////////////////////////////////////////////////////////////////////////////
211 
212 // Forward declarations:
214 typedef std::shared_ptr<PcpErrorInconsistentPropertyType>
216 
217 /// \class PcpErrorInconsistentPropertyType
218 ///
219 /// Properties that have specs with conflicting definitions.
220 ///
223 public:
224  /// Returns a new error object.
226  /// Destructor.
228  /// Converts error to string message.
229  PCP_API std::string ToString() const override;
230 
231  /// The type of the defining spec.
233  /// The type of the conflicting spec.
235 
236 private:
237  /// Constructor is private. Use New() instead.
239 };
240 
241 ///////////////////////////////////////////////////////////////////////////////
242 
243 // Forward declarations:
245 typedef std::shared_ptr<PcpErrorInconsistentAttributeType>
247 
248 /// \class PcpErrorInconsistentAttributeType
249 ///
250 /// Attributes that have specs with conflicting definitions.
251 ///
254 public:
255  /// Returns a new error object.
257  /// Destructor.
259  /// Converts error to string message.
260  PCP_API std::string ToString() const override;
261 
262  /// The value type from the defining spec.
264  /// The value type from the conflicting spec.
266 
267 private:
268  /// Constructor is private. Use New() instead.
270 };
271 
272 ///////////////////////////////////////////////////////////////////////////////
273 
274 // Forward declarations:
276 typedef std::shared_ptr<PcpErrorInconsistentAttributeVariability>
278 
279 /// \class PcpErrorInconsistentAttributeVariability
280 ///
281 /// Attributes that have specs with conflicting variability.
282 ///
285 public:
286  /// Returns a new error object.
288  /// Destructor.
290  /// Converts error to string message.
291  PCP_API std::string ToString() const override;
292 
293  /// The variability of the defining spec.
295  /// The variability of the conflicting spec.
297 
298 private:
299  /// Constructor is private. Use New() instead.
301 };
302 
303 ///////////////////////////////////////////////////////////////////////////////
304 
305 // Forward declarations:
307 typedef std::shared_ptr<PcpErrorInvalidPrimPath>
309 
310 /// \class PcpErrorInvalidPrimPath
311 ///
312 /// Invalid prim paths used by references or payloads.
313 ///
315 public:
316  /// Returns a new error object.
318  /// Destructor.
320  /// Converts error to string message.
321  PCP_API std::string ToString() const override;
322 
323  /// The site where the invalid arc was expressed.
325 
326  /// The target prim path of the arc that is invalid.
328 
329  /// The source layer of the spec that caused this arc to be introduced.
330  /// This may be a sublayer of the site.
331  SdfLayerHandle sourceLayer;
332 
334 
335 private:
336  /// Constructor is private. Use New() instead.
338 };
339 
340 ///////////////////////////////////////////////////////////////////////////////
341 
342 // Forward declarations:
344 typedef std::shared_ptr<PcpErrorInvalidAssetPathBase>
346 
348 public:
349  /// Destructor.
351 
352  /// The site where the invalid arc was expressed.
354 
355  /// The target prim path of the arc.
357 
358  /// The target asset path of the arc as authored.
360 
361  /// The resolved target asset path of the arc.
363 
364  /// The source layer of the spec that caused this arc to be introduced.
365  /// This may be a sublayer of the site.
366  SdfLayerHandle sourceLayer;
367 
369 
370  /// Additional provided error information.
372 
373 protected:
374  /// Constructor.
376 };
377 
378 ///////////////////////////////////////////////////////////////////////////////
379 
380 // Forward declarations:
382 typedef std::shared_ptr<PcpErrorInvalidAssetPath>
384 
385 /// \class PcpErrorInvalidAssetPath
386 ///
387 /// Invalid asset paths used by references or payloads.
388 ///
390 public:
391  /// Returns a new error object.
393  /// Destructor.
395  /// Converts error to string message.
396  PCP_API std::string ToString() const override;
397 
398 private:
399  /// Constructor is private. Use New() instead.
401 };
402 
403 ///////////////////////////////////////////////////////////////////////////////
404 
405 // Forward declarations:
407 typedef std::shared_ptr<PcpErrorMutedAssetPath>
409 
410 /// \class PcpErrorMutedAssetPath
411 ///
412 /// Muted asset paths used by references or payloads.
413 ///
415 public:
416  /// Returns a new error object.
418  /// Destructor.
419  PCP_API ~PcpErrorMutedAssetPath() override;
420  /// Converts error to string message.
421  PCP_API std::string ToString() const override;
422 
423 private:
424  /// Constructor is private. Use New() instead.
426 };
427 
428 ///////////////////////////////////////////////////////////////////////////////
429 
430 // Forward declarations:
432 typedef std::shared_ptr<PcpErrorTargetPathBase>
434 
435 /// \class PcpErrorTargetPathBase
436 ///
437 /// Base class for composition errors related to target or connection paths.
438 ///
440 public:
441  /// Destructor.
442  PCP_API ~PcpErrorTargetPathBase() override;
443 
444  /// The invalid target or connection path that was authored.
446  /// The path to the property where the target was authored.
448  /// The spec type of the property where the target was authored.
450  /// The layer containing the property where the target was authored.
451  SdfLayerHandle layer;
452 
453  /// The target or connection path in the composed scene.
454  /// If this path could not be translated to the composed scene
455  /// (e.g., in the case of an invalid external target path),
456  /// this path will be empty.
458 
459 protected:
461 };
462 
463 ///////////////////////////////////////////////////////////////////////////////
464 
465 // Forward declarations:
467 typedef std::shared_ptr<PcpErrorInvalidInstanceTargetPath>
469 
470 /// \class PcpErrorInvalidInstanceTargetPath
471 ///
472 /// Invalid target or connection path authored in an inherited
473 /// class that points to an instance of that class.
474 ///
476 public:
477  /// Returns a new error object.
479  /// Destructor.
481  /// Converts error to string message.
482  PCP_API std::string ToString() const override;
483 
484 private:
485  /// Constructor is private. Use New() instead.
487 };
488 
489 ///////////////////////////////////////////////////////////////////////////////
490 
491 // Forward declarations:
493 typedef std::shared_ptr<PcpErrorInvalidExternalTargetPath>
495 
496 /// \class PcpErrorInvalidExternalTargetPath
497 ///
498 /// Invalid target or connection path in some scope that points to
499 /// an object outside of that scope.
500 ///
502 public:
503  /// Returns a new error object.
505  /// Destructor.
507  /// Converts error to string message.
508  PCP_API std::string ToString() const override;
509 
512 
513 private:
514  /// Constructor is private. Use New() instead.
516 };
517 
518 ///////////////////////////////////////////////////////////////////////////////
519 
520 // Forward declarations:
522 typedef std::shared_ptr<PcpErrorInvalidTargetPath>
524 
525 /// \class PcpErrorInvalidTargetPath
526 ///
527 /// Invalid target or connection path.
528 ///
530 public:
531  /// Returns a new error object.
533  /// Destructor.
535  /// Converts error to string message.
536  PCP_API std::string ToString() const override;
537 
538 private:
539  /// Constructor is private. Use New() instead.
541 };
542 
543 ///////////////////////////////////////////////////////////////////////////////
544 
545 // Forward declarations:
547 typedef std::shared_ptr<PcpErrorInvalidSublayerOffset>
549 
550 /// \class PcpErrorInvalidSublayerOffset
551 ///
552 /// Sublayers that use invalid layer offsets.
553 ///
555 public:
556  /// Returns a new error object.
558  /// Destructor.
560  /// Converts error to string message.
561  PCP_API std::string ToString() const override;
562 
563  SdfLayerHandle layer;
564  SdfLayerHandle sublayer;
566 
567 private:
568  /// Constructor is private. Use New() instead.
570 };
571 
572 ///////////////////////////////////////////////////////////////////////////////
573 
574 // Forward declarations:
576 typedef std::shared_ptr<PcpErrorInvalidReferenceOffset>
578 
579 /// \class PcpErrorInvalidReferenceOffset
580 ///
581 /// References or payloads that use invalid layer offsets.
582 ///
584 public:
585  /// Returns a new error object.
587  /// Destructor.
589  /// Converts error to string message.
590  PCP_API std::string ToString() const override;
591 
592  /// The source layer of the spec that caused this arc to be introduced.
593  SdfLayerHandle sourceLayer;
594 
595  /// The source path of the spec that caused this arc to be introduced.
597 
598  /// Target asset path of the arc.
600 
601  /// Target prim path of the arc.
603 
604  /// The invalid layer offset expressed on the arc.
606 
608 
609 private:
610  /// Constructor is private. Use New() instead.
612 };
613 
614 ///////////////////////////////////////////////////////////////////////////////
615 
616 // Forward declarations:
618 typedef std::shared_ptr<PcpErrorInvalidSublayerOwnership>
620 
621 /// \class PcpErrorInvalidSublayerOwnership
622 ///
623 /// Sibling layers that have the same owner.
624 ///
626 public:
627  /// Returns a new error object.
629  /// Destructor.
631  /// Converts error to string message.
632  PCP_API std::string ToString() const override;
633 
635  SdfLayerHandle layer;
636  SdfLayerHandleVector sublayers;
637 
638 private:
639  /// Constructor is private. Use New() instead.
641 };
642 
643 ///////////////////////////////////////////////////////////////////////////////
644 
645 // Forward declarations:
647 typedef std::shared_ptr<PcpErrorInvalidSublayerPath>
649 
650 /// \class PcpErrorInvalidSublayerPath
651 ///
652 /// Asset paths that could not be both resolved and loaded.
653 ///
655 public:
656  /// Returns a new error object.
658  /// Destructor.
660  /// Converts error to string message.
661  PCP_API std::string ToString() const override;
662 
663  SdfLayerHandle layer;
666 
667 private:
668  /// Constructor is private. Use New() instead.
670 };
671 
672 ///////////////////////////////////////////////////////////////////////////////
673 
674 // Forward declarations:
676 typedef std::shared_ptr<PcpErrorOpinionAtRelocationSource>
678 
679 /// \class PcpErrorOpinionAtRelocationSource
680 ///
681 /// Opinions were found at a relocation source path.
682 ///
684 public:
685  /// Returns a new error object.
687  /// Destructor.
689  /// Converts error to string message.
690  PCP_API std::string ToString() const override;
691 
692  SdfLayerHandle layer;
694 
695 private:
696  /// Constructor is private. Use New() instead.
698 };
699 
700 ///////////////////////////////////////////////////////////////////////////////
701 
702 // Forward declarations:
704 typedef std::shared_ptr<PcpErrorPrimPermissionDenied>
706 
707 /// \class PcpErrorPrimPermissionDenied
708 ///
709 /// Layers with illegal opinions about private prims.
710 ///
712 public:
713  /// Returns a new error object.
715  /// Destructor.
717  /// Converts error to string message.
718  PCP_API std::string ToString() const override;
719 
720  /// The site where the invalid arc was expressed.
722  /// The private, invalid target of the arc.
724 
725 private:
726  /// Constructor is private. Use New() instead.
728 };
729 
730 ///////////////////////////////////////////////////////////////////////////////
731 
732 // Forward declarations:
734 typedef std::shared_ptr<PcpErrorPropertyPermissionDenied>
736 
737 /// \class PcpErrorPropertyPermissionDenied
738 ///
739 /// Layers with illegal opinions about private properties.
740 ///
742 public:
743  /// Returns a new error object.
745  /// Destructor.
747  /// Converts error to string message.
748  PCP_API std::string ToString() const override;
749 
753 
754 private:
755  /// Constructor is private. Use New() instead.
757 };
758 
759 ///////////////////////////////////////////////////////////////////////////////
760 
761 // Forward declarations:
763 typedef std::shared_ptr<PcpErrorSublayerCycle> PcpErrorSublayerCyclePtr;
764 
765 /// \class PcpErrorSublayerCycle
766 ///
767 /// Layers that recursively sublayer themselves.
768 ///
770 public:
771  /// Returns a new error object.
772  static PcpErrorSublayerCyclePtr New();
773  /// Destructor.
774  PCP_API ~PcpErrorSublayerCycle() override;
775  /// Converts error to string message.
776  PCP_API std::string ToString() const override;
777 
778  SdfLayerHandle layer;
779  SdfLayerHandle sublayer;
780 
781 private:
782  /// Constructor is private. Use New() instead.
784 };
785 
786 ///////////////////////////////////////////////////////////////////////////////
787 
788 // Forward declarations:
790 typedef std::shared_ptr<PcpErrorTargetPermissionDenied>
792 
793 /// \class PcpErrorTargetPermissionDenied
794 ///
795 /// Paths with illegal opinions about private targets.
796 ///
798 public:
799  /// Returns a new error object.
801  /// Destructor.
803  /// Converts error to string message.
804  PCP_API std::string ToString() const override;
805 
806 private:
807  /// Constructor is private. Use New() instead.
809 };
810 
811 ///////////////////////////////////////////////////////////////////////////////
812 
813 // Forward declarations:
815 typedef std::shared_ptr<PcpErrorUnresolvedPrimPath>
817 
818 /// \class PcpErrorUnresolvedPrimPath
819 ///
820 /// Asset paths that could not be both resolved and loaded.
821 ///
823 public:
824  /// Returns a new error object.
826  /// Destructor.
828  /// Converts error to string message.
829  PCP_API std::string ToString() const override;
830 
831  /// The site where the invalid arc was expressed.
833 
834  /// The source layer of the spec that caused this arc to be introduced.
835  /// This may be a sublayer of the site.
836  SdfLayerHandle sourceLayer;
837 
838  /// The target layer of the arc.
839  SdfLayerHandle targetLayer;
840 
841  /// The prim path that cannot be resolved on the target layer stack.
843 
845 
846 private:
847  /// Constructor is private. Use New() instead.
849 };
850 
851 ///////////////////////////////////////////////////////////////////////////////
852 
853 // Forward declarations:
855 typedef std::shared_ptr<PcpErrorVariableExpressionError>
857 
858 /// \class PcpErrorVariableExpressionError
859 ///
860 /// Error when evaluating a variable expression.
861 ///
863 public:
865 
867 
868  PCP_API std::string ToString() const override;
869 
870  /// The expression that was evaluated.
872 
873  /// The error generated during evaluation.
875 
876  /// The context where the expression was authored, e.g.
877  /// "sublayer", "reference", etc.
879 
880  /// The source layer where the expression was authored.
881  SdfLayerHandle sourceLayer;
882 
883  /// The source path where the expression was authored. This
884  /// may be the absolute root path.
886 
887 private:
888  /// Constructor is private. Use New() instead.
890 };
891 
892 ///////////////////////////////////////////////////////////////////////////////
893 
894 /// Raise the given errors as runtime errors.
895 PCP_API
896 void PcpRaiseErrors(const PcpErrorVector &errors);
897 
899 
900 #endif // PXR_USD_PCP_ERRORS_H
PcpErrorTargetPathBase(PcpErrorType errorType)
PCP_API ~PcpErrorInvalidAssetPath() override
Destructor.
PCP_API ~PcpErrorInconsistentAttributeType() override
Destructor.
SdfPath composedTargetPath
Definition: errors.h:457
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:324
SdfLayerHandle sourceLayer
Definition: errors.h:836
std::shared_ptr< PcpErrorMutedAssetPath > PcpErrorMutedAssetPathPtr
Definition: errors.h:406
PCP_API ~PcpErrorInvalidSublayerOwnership() override
Destructor.
std::shared_ptr< PcpErrorInvalidAssetPath > PcpErrorInvalidAssetPathPtr
Definition: errors.h:381
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorOpinionAtRelocationSource() override
Destructor.
std::string conflictingLayerIdentifier
The identifier of the layer with the conflicting property spec.
Definition: errors.h:201
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API std::string ToString() const override
Converts error to string message.
PcpErrorInvalidAssetPathBase(PcpErrorType errorType)
Constructor.
static PcpErrorInconsistentAttributeTypePtr New()
Returns a new error object.
static PcpErrorTargetPermissionDeniedPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorTargetPermissionDenied > PcpErrorTargetPermissionDeniedPtr
Definition: errors.h:789
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath owningPath
The path to the property where the target was authored.
Definition: errors.h:447
PCP_API ~PcpErrorInvalidAssetPathBase() override
Destructor.
std::string assetPath
The target asset path of the arc as authored.
Definition: errors.h:359
PCP_API ~PcpErrorInconsistentAttributeVariability() override
Destructor.
static PcpErrorInvalidSublayerOwnershipPtr New()
Returns a new error object.
SdfPath targetPath
The invalid target or connection path that was authored.
Definition: errors.h:445
PcpErrorType
Definition: errors.h:45
SdfVariability conflictingVariability
The variability of the conflicting spec.
Definition: errors.h:296
std::shared_ptr< PcpErrorPropertyPermissionDenied > PcpErrorPropertyPermissionDeniedPtr
Definition: errors.h:733
static PcpErrorInconsistentAttributeVariabilityPtr New()
Returns a new error object.
SdfPath primPath
The target prim path of the arc that is invalid.
Definition: errors.h:327
std::shared_ptr< PcpErrorInvalidSublayerOwnership > PcpErrorInvalidSublayerOwnershipPtr
Definition: errors.h:617
std::shared_ptr< PcpErrorOpinionAtRelocationSource > PcpErrorOpinionAtRelocationSourcePtr
Definition: errors.h:675
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerHandleVector sublayers
Definition: errors.h:636
PCP_API ~PcpErrorTargetPermissionDenied() override
Destructor.
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorInvalidTargetPath() override
Destructor.
std::shared_ptr< PcpErrorInconsistentPropertyType > PcpErrorInconsistentPropertyTypePtr
Definition: errors.h:213
PCP_API ~PcpErrorInvalidReferenceOffset() override
Destructor.
Definition: site.h:45
PCP_API ~PcpErrorInconsistentPropertyType() override
Destructor.
virtual std::string ToString() const =0
Converts error to string message.
std::shared_ptr< PcpErrorInvalidTargetPath > PcpErrorInvalidTargetPathPtr
Definition: errors.h:521
SdfPath unresolvedPath
The prim path that cannot be resolved on the target layer stack.
Definition: errors.h:842
virtual PCP_API ~PcpErrorBase()
Destructor.
const PcpErrorType errorType
The error code.
Definition: errors.h:92
std::shared_ptr< PcpErrorInvalidSublayerOffset > PcpErrorInvalidSublayerOffsetPtr
Definition: errors.h:546
SdfSpecType definingSpecType
The type of the defining spec.
Definition: errors.h:232
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath definingSpecPath
The path of the defining property spec.
Definition: errors.h:198
static PcpErrorMutedAssetPathPtr New()
Returns a new error object.
PCP_API ~PcpErrorMutedAssetPath() override
Destructor.
SdfLayerHandle sourceLayer
The source layer where the expression was authored.
Definition: errors.h:881
SdfLayerHandle layer
Definition: errors.h:563
SdfPath sourcePath
The source path of the spec that caused this arc to be introduced.
Definition: errors.h:596
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorSublayerCycle() override
Destructor.
std::string expression
The expression that was evaluated.
Definition: errors.h:871
PCP_API std::string ToString() const override
Converts error to string message.
std::shared_ptr< PcpErrorBase > PcpErrorBasePtr
Definition: errors.h:76
PCP_API ~PcpErrorInvalidInstanceTargetPath() override
Destructor.
PCP_API ~PcpErrorInvalidExternalTargetPath() override
Destructor.
static PcpErrorInvalidReferenceOffsetPtr New()
Returns a new error object.
static PcpErrorSublayerCyclePtr New()
Returns a new error object.
SdfLayerHandle layer
Definition: errors.h:663
PcpErrorBase(PcpErrorType errorType)
Constructor.
TfToken definingValueType
The value type from the defining spec.
Definition: errors.h:263
static PcpErrorInvalidPrimPathPtr New()
Returns a new error object.
static PcpErrorInvalidTargetPathPtr New()
Returns a new error object.
Definition: token.h:87
SdfLayerHandle sublayer
Definition: errors.h:779
PCP_API ~PcpErrorArcPermissionDenied() override
Destructor.
PCP_API ~PcpErrorPropertyPermissionDenied() override
Destructor.
PCP_API ~PcpErrorUnresolvedPrimPath() override
Destructor.
SdfLayerHandle sourceLayer
Definition: errors.h:331
std::shared_ptr< PcpErrorInvalidReferenceOffset > PcpErrorInvalidReferenceOffsetPtr
Definition: errors.h:575
static PcpErrorCapacityExceededPtr New(PcpErrorType errorType)
Returns a new error object.
std::shared_ptr< PcpErrorTargetPathBase > PcpErrorTargetPathBasePtr
Definition: errors.h:431
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API std::string ToString() const override
Converts error to string message.
SdfVariability definingVariability
The variability of the defining spec.
Definition: errors.h:294
PCP_API ~PcpErrorTargetPathBase() override
Destructor.
std::shared_ptr< PcpErrorInconsistentAttributeVariability > PcpErrorInconsistentAttributeVariabilityPtr
Definition: errors.h:275
std::shared_ptr< PcpErrorArcCycle > PcpErrorArcCyclePtr
Definition: errors.h:108
PCP_API ~PcpErrorCapacityExceeded() override
Destructor.
SdfLayerHandle sublayer
Definition: errors.h:564
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerOffset offset
Definition: errors.h:565
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorVariableExpressionError() override
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:723
std::shared_ptr< PcpErrorInvalidExternalTargetPath > PcpErrorInvalidExternalTargetPathPtr
Definition: errors.h:492
std::shared_ptr< PcpErrorInvalidSublayerPath > PcpErrorInvalidSublayerPathPtr
Definition: errors.h:646
static PcpErrorInconsistentPropertyTypePtr New()
Returns a new error object.
std::string expressionError
The error generated during evaluation.
Definition: errors.h:874
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API std::string ToString() const override
Converts error to string message.
std::shared_ptr< PcpErrorInvalidInstanceTargetPath > PcpErrorInvalidInstanceTargetPathPtr
Definition: errors.h:466
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:721
SdfPath conflictingSpecPath
The path of the conflicting property spec.
Definition: errors.h:203
std::shared_ptr< PcpErrorCapacityExceeded > PcpErrorCapacityExceededPtr
Definition: errors.h:167
static PcpErrorPrimPermissionDeniedPtr New()
Returns a new error object.
SdfSpecType conflictingSpecType
The type of the conflicting spec.
Definition: errors.h:234
std::shared_ptr< PcpErrorPrimPermissionDenied > PcpErrorPrimPermissionDeniedPtr
Definition: errors.h:703
static PcpErrorInvalidAssetPathPtr New()
Returns a new error object.
std::string definingLayerIdentifier
The identifier of the layer with the defining property spec.
Definition: errors.h:196
std::string assetPath
Target asset path of the arc.
Definition: errors.h:599
Definition: path.h:290
PCP_API ~PcpErrorInconsistentPropertyBase() override
Destructor.
std::vector< PcpErrorBasePtr > PcpErrorVector
Definition: errors.h:78
SdfLayerHandle targetLayer
The target layer of the arc.
Definition: errors.h:839
static PcpErrorInvalidInstanceTargetPathPtr New()
Returns a new error object.
PCP_API ~PcpErrorPrimPermissionDenied() override
Destructor.
static PcpErrorArcCyclePtr New()
Returns a new error object.
SdfLayerOffset offset
The invalid layer offset expressed on the arc.
Definition: errors.h:605
std::shared_ptr< PcpErrorSublayerCycle > PcpErrorSublayerCyclePtr
Definition: errors.h:762
SdfVariability
Definition: types.h:173
static PcpErrorVariableExpressionErrorPtr New()
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerHandle layer
Definition: errors.h:778
static PcpErrorInvalidExternalTargetPathPtr New()
Returns a new error object.
SdfPath targetPath
Target prim path of the arc.
Definition: errors.h:602
PcpArcType arcType
Definition: errors.h:333
std::shared_ptr< PcpErrorInconsistentAttributeType > PcpErrorInconsistentAttributeTypePtr
Definition: errors.h:244
PCP_API std::string ToString() const override
Converts error to string message.
TfToken conflictingValueType
The value type from the conflicting spec.
Definition: errors.h:265
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
std::string messages
Additional provided error information.
Definition: errors.h:371
SdfSpecType
Definition: types.h:85
std::string sublayerPath
Definition: errors.h:664
PcpErrorInconsistentPropertyBase(PcpErrorType errorType)
Constructor.
PCP_API std::string ToString() const override
Converts error to string message.
std::vector< PcpSiteTrackerSegment > PcpSiteTracker
Definition: types.h:128
PCP_API std::string ToString() const override
Converts error to string message.
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:155
PCP_API void PcpRaiseErrors(const PcpErrorVector &errors)
Raise the given errors as runtime errors.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::shared_ptr< PcpErrorVariableExpressionError > PcpErrorVariableExpressionErrorPtr
Definition: errors.h:854
static PcpErrorInvalidSublayerOffsetPtr New()
Returns a new error object.
SdfSpecType ownerSpecType
The spec type of the property where the target was authored.
Definition: errors.h:449
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath targetPath
The target prim path of the arc.
Definition: errors.h:356
static PcpErrorPropertyPermissionDeniedPtr New()
Returns a new error object.
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:153
std::shared_ptr< PcpErrorInvalidAssetPathBase > PcpErrorInvalidAssetPathBasePtr
Definition: errors.h:343
std::shared_ptr< PcpErrorInvalidPrimPath > PcpErrorInvalidPrimPathPtr
Definition: errors.h:306
PCP_API ~PcpErrorInvalidSublayerPath() override
Destructor.
std::string resolvedAssetPath
The resolved target asset path of the arc.
Definition: errors.h:362
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:353
static PcpErrorUnresolvedPrimPathPtr New()
Returns a new error object.
static PcpErrorArcPermissionDeniedPtr New()
Returns a new error object.
static PcpErrorInvalidSublayerPathPtr New()
Returns a new error object.
PcpArcType arcType
The type of arc.
Definition: errors.h:157
std::shared_ptr< PcpErrorUnresolvedPrimPath > PcpErrorUnresolvedPrimPathPtr
Definition: errors.h:814
std::shared_ptr< PcpErrorArcPermissionDenied > PcpErrorArcPermissionDeniedPtr
Definition: errors.h:134
PCP_API ~PcpErrorInvalidPrimPath() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorOpinionAtRelocationSourcePtr New()
Returns a new error object.
PcpSiteTracker cycle
Definition: errors.h:124
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:832
PCP_API ~PcpErrorInvalidSublayerOffset() override
Destructor.
PcpSite rootSite
Definition: errors.h:98
SdfLayerHandle sourceLayer
Definition: errors.h:366
PCP_API ~PcpErrorArcCycle() override
Destructor.
SdfLayerHandle layer
The layer containing the property where the target was authored.
Definition: errors.h:451
SdfLayerHandle sourceLayer
The source layer of the spec that caused this arc to be introduced.
Definition: errors.h:593
#define PCP_API
Definition: api.h:40
PcpArcType
Definition: types.h:44