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 terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_USD_PCP_ERRORS_H
8 #define PXR_USD_PCP_ERRORS_H
9 
10 #include "pxr/pxr.h"
11 #include "pxr/usd/pcp/api.h"
12 #include "pxr/usd/pcp/site.h"
13 #include "pxr/usd/pcp/types.h"
14 #include "pxr/usd/sdf/layer.h"
16 #include "pxr/usd/sdf/path.h"
17 
18 #include <memory>
19 #include <string>
20 #include <vector>
21 
23 
24 /// \enum PcpErrorType
25 ///
26 /// Enum to indicate the type represented by a Pcp error.
27 ///
60 };
61 
62 // Forward declarations:
64 typedef std::shared_ptr<PcpErrorBase> PcpErrorBasePtr;
65 typedef std::vector<PcpErrorBasePtr> PcpErrorVector;
66 
67 /// \class PcpErrorBase
68 ///
69 /// Base class for all error types.
70 ///
71 class PcpErrorBase {
72 public:
73  /// Destructor.
74  PCP_API virtual ~PcpErrorBase();
75  /// Converts error to string message.
76  virtual std::string ToString() const = 0;
77 
78  /// The error code.
80 
81  /// The site of the composed prim or property being computed when
82  /// the error was encountered. (Note that some error types
83  /// contain an additional site to capture more specific information
84  /// about the site of the error.)
86 
87 protected:
88  /// Constructor.
90 };
91 
92 ///////////////////////////////////////////////////////////////////////////////
93 
94 // Forward declarations:
96 typedef std::shared_ptr<PcpErrorArcCycle> PcpErrorArcCyclePtr;
97 
98 /// \class PcpErrorArcCycle
99 ///
100 /// Arcs between PcpNodes that form a cycle.
101 ///
103 public:
104  /// Returns a new error object.
105  static PcpErrorArcCyclePtr New();
106  /// Destructor.
107  PCP_API ~PcpErrorArcCycle() override;
108  /// Converts error to string message.
109  PCP_API std::string ToString() const override;
110 
112 
113 private:
114  /// Constructor is private. Use New() instead.
116 };
117 
118 ///////////////////////////////////////////////////////////////////////////////
119 
120 // Forward declarations:
122 typedef std::shared_ptr<PcpErrorArcPermissionDenied>
124 
125 /// \class PcpErrorArcPermissionDenied
126 ///
127 /// Arcs that were not made between PcpNodes because of permission
128 /// restrictions.
129 ///
131 public:
132  /// Returns a new error object.
134  /// Destructor.
136  /// Converts error to string message.
137  PCP_API std::string ToString() const override;
138 
139  /// The site where the invalid arc was expressed.
141  /// The private, invalid target of the arc.
143  /// The type of arc.
145 
146 private:
147  /// Constructor is private. Use New() instead.
149 };
150 
151 ///////////////////////////////////////////////////////////////////////////////
152 
153 // Forward declarations:
155 typedef std::shared_ptr<PcpErrorArcToProhibitedChild>
157 
158 /// \class PcpErrorArcToProhibitedChild
159 ///
160 /// Arcs that were not made between PcpNodes because the target is a prohibited
161 /// child prim of its parent due to relocations.
162 ///
164 public:
165  /// Returns a new error object.
167  /// Destructor.
169  /// Converts error to string message.
170  PCP_API std::string ToString() const override;
171 
172  /// The site where the invalid arc was expressed.
174  /// The target site of the invalid arc which is a prohibited child.
176  /// The site of the node under targetSite that is a relocation source in its
177  /// layer stack.
179  /// The type of arc.
181 
182 private:
183  /// Constructor is private. Use New() instead.
185 };
186 
187 ///////////////////////////////////////////////////////////////////////////////
188 
189 // Forward declarations:
191 typedef std::shared_ptr<PcpErrorCapacityExceeded> PcpErrorCapacityExceededPtr;
192 
193 /// \class PcpErrorCapacityExceeded
194 ///
195 /// Exceeded the capacity for composition arcs at a single site.
196 ///
198 public:
199  /// Returns a new error object.
201  /// Destructor.
203  /// Converts error to string message.
204  PCP_API std::string ToString() const override;
205 
206 private:
207  /// Constructor is private. Use New() instead.
209 };
210 
211 ///////////////////////////////////////////////////////////////////////////////
212 
214 public:
215  /// Destructor.
217 
218  /// The identifier of the layer with the defining property spec.
220  /// The path of the defining property spec.
222 
223  /// The identifier of the layer with the conflicting property spec.
225  /// The path of the conflicting property spec.
227 
228 protected:
229  /// Constructor.
231 };
232 
233 ///////////////////////////////////////////////////////////////////////////////
234 
235 // Forward declarations:
237 typedef std::shared_ptr<PcpErrorInconsistentPropertyType>
239 
240 /// \class PcpErrorInconsistentPropertyType
241 ///
242 /// Properties that have specs with conflicting definitions.
243 ///
246 public:
247  /// Returns a new error object.
249  /// Destructor.
251  /// Converts error to string message.
252  PCP_API std::string ToString() const override;
253 
254  /// The type of the defining spec.
256  /// The type of the conflicting spec.
258 
259 private:
260  /// Constructor is private. Use New() instead.
262 };
263 
264 ///////////////////////////////////////////////////////////////////////////////
265 
266 // Forward declarations:
268 typedef std::shared_ptr<PcpErrorInconsistentAttributeType>
270 
271 /// \class PcpErrorInconsistentAttributeType
272 ///
273 /// Attributes that have specs with conflicting definitions.
274 ///
277 public:
278  /// Returns a new error object.
280  /// Destructor.
282  /// Converts error to string message.
283  PCP_API std::string ToString() const override;
284 
285  /// The value type from the defining spec.
287  /// The value type from the conflicting spec.
289 
290 private:
291  /// Constructor is private. Use New() instead.
293 };
294 
295 ///////////////////////////////////////////////////////////////////////////////
296 
297 // Forward declarations:
299 typedef std::shared_ptr<PcpErrorInconsistentAttributeVariability>
301 
302 /// \class PcpErrorInconsistentAttributeVariability
303 ///
304 /// Attributes that have specs with conflicting variability.
305 ///
308 public:
309  /// Returns a new error object.
311  /// Destructor.
313  /// Converts error to string message.
314  PCP_API std::string ToString() const override;
315 
316  /// The variability of the defining spec.
318  /// The variability of the conflicting spec.
320 
321 private:
322  /// Constructor is private. Use New() instead.
324 };
325 
326 ///////////////////////////////////////////////////////////////////////////////
327 
328 // Forward declarations:
330 typedef std::shared_ptr<PcpErrorInvalidPrimPath>
332 
333 /// \class PcpErrorInvalidPrimPath
334 ///
335 /// Invalid prim paths used by references or payloads.
336 ///
338 public:
339  /// Returns a new error object.
341  /// Destructor.
343  /// Converts error to string message.
344  PCP_API std::string ToString() const override;
345 
346  /// The site where the invalid arc was expressed.
348 
349  /// The target prim path of the arc that is invalid.
351 
352  /// The source layer of the spec that caused this arc to be introduced.
353  /// This may be a sublayer of the site.
354  SdfLayerHandle sourceLayer;
355 
357 
358 private:
359  /// Constructor is private. Use New() instead.
361 };
362 
363 ///////////////////////////////////////////////////////////////////////////////
364 
365 // Forward declarations:
367 typedef std::shared_ptr<PcpErrorInvalidAssetPathBase>
369 
371 public:
372  /// Destructor.
374 
375  /// The site where the invalid arc was expressed.
377 
378  /// The target prim path of the arc.
380 
381  /// The target asset path of the arc as authored.
382  std::string assetPath;
383 
384  /// The resolved target asset path of the arc.
385  std::string resolvedAssetPath;
386 
387  /// The source layer of the spec that caused this arc to be introduced.
388  /// This may be a sublayer of the site.
389  SdfLayerHandle sourceLayer;
390 
392 
393  /// Additional provided error information.
394  std::string messages;
395 
396 protected:
397  /// Constructor.
399 };
400 
401 ///////////////////////////////////////////////////////////////////////////////
402 
403 // Forward declarations:
405 typedef std::shared_ptr<PcpErrorInvalidAssetPath>
407 
408 /// \class PcpErrorInvalidAssetPath
409 ///
410 /// Invalid asset paths used by references or payloads.
411 ///
413 public:
414  /// Returns a new error object.
416  /// Destructor.
418  /// Converts error to string message.
419  PCP_API std::string ToString() const override;
420 
421 private:
422  /// Constructor is private. Use New() instead.
424 };
425 
426 ///////////////////////////////////////////////////////////////////////////////
427 
428 // Forward declarations:
430 typedef std::shared_ptr<PcpErrorMutedAssetPath>
432 
433 /// \class PcpErrorMutedAssetPath
434 ///
435 /// Muted asset paths used by references or payloads.
436 ///
438 public:
439  /// Returns a new error object.
441  /// Destructor.
442  PCP_API ~PcpErrorMutedAssetPath() override;
443  /// Converts error to string message.
444  PCP_API std::string ToString() const override;
445 
446 private:
447  /// Constructor is private. Use New() instead.
449 };
450 
451 ///////////////////////////////////////////////////////////////////////////////
452 
453 // Forward declarations:
455 typedef std::shared_ptr<PcpErrorTargetPathBase>
457 
458 /// \class PcpErrorTargetPathBase
459 ///
460 /// Base class for composition errors related to target or connection paths.
461 ///
463 public:
464  /// Destructor.
465  PCP_API ~PcpErrorTargetPathBase() override;
466 
467  /// The invalid target or connection path that was authored.
469  /// The path to the property where the target was authored.
471  /// The spec type of the property where the target was authored.
473  /// The layer containing the property where the target was authored.
474  SdfLayerHandle layer;
475 
476  /// The target or connection path in the composed scene.
477  /// If this path could not be translated to the composed scene
478  /// (e.g., in the case of an invalid external target path),
479  /// this path will be empty.
481 
482 protected:
484 };
485 
486 ///////////////////////////////////////////////////////////////////////////////
487 
488 // Forward declarations:
490 typedef std::shared_ptr<PcpErrorInvalidInstanceTargetPath>
492 
493 /// \class PcpErrorInvalidInstanceTargetPath
494 ///
495 /// Invalid target or connection path authored in an inherited
496 /// class that points to an instance of that class.
497 ///
499 public:
500  /// Returns a new error object.
502  /// Destructor.
504  /// Converts error to string message.
505  PCP_API std::string ToString() const override;
506 
507 private:
508  /// Constructor is private. Use New() instead.
510 };
511 
512 ///////////////////////////////////////////////////////////////////////////////
513 
514 // Forward declarations:
516 typedef std::shared_ptr<PcpErrorInvalidExternalTargetPath>
518 
519 /// \class PcpErrorInvalidExternalTargetPath
520 ///
521 /// Invalid target or connection path in some scope that points to
522 /// an object outside of that scope.
523 ///
525 public:
526  /// Returns a new error object.
528  /// Destructor.
530  /// Converts error to string message.
531  PCP_API std::string ToString() const override;
532 
535 
536 private:
537  /// Constructor is private. Use New() instead.
539 };
540 
541 ///////////////////////////////////////////////////////////////////////////////
542 
543 // Forward declarations:
545 typedef std::shared_ptr<PcpErrorInvalidTargetPath>
547 
548 /// \class PcpErrorInvalidTargetPath
549 ///
550 /// Invalid target or connection path.
551 ///
553 public:
554  /// Returns a new error object.
556  /// Destructor.
558  /// Converts error to string message.
559  PCP_API std::string ToString() const override;
560 
561 private:
562  /// Constructor is private. Use New() instead.
564 };
565 
566 ///////////////////////////////////////////////////////////////////////////////
567 
568 // Forward declarations:
570 typedef std::shared_ptr<PcpErrorInvalidSublayerOffset>
572 
573 /// \class PcpErrorInvalidSublayerOffset
574 ///
575 /// Sublayers that use invalid layer offsets.
576 ///
578 public:
579  /// Returns a new error object.
581  /// Destructor.
583  /// Converts error to string message.
584  PCP_API std::string ToString() const override;
585 
586  SdfLayerHandle layer;
587  SdfLayerHandle sublayer;
589 
590 private:
591  /// Constructor is private. Use New() instead.
593 };
594 
595 ///////////////////////////////////////////////////////////////////////////////
596 
597 // Forward declarations:
599 typedef std::shared_ptr<PcpErrorInvalidReferenceOffset>
601 
602 /// \class PcpErrorInvalidReferenceOffset
603 ///
604 /// References or payloads that use invalid layer offsets.
605 ///
607 public:
608  /// Returns a new error object.
610  /// Destructor.
612  /// Converts error to string message.
613  PCP_API std::string ToString() const override;
614 
615  /// The source layer of the spec that caused this arc to be introduced.
616  SdfLayerHandle sourceLayer;
617 
618  /// The source path of the spec that caused this arc to be introduced.
620 
621  /// Target asset path of the arc.
622  std::string assetPath;
623 
624  /// Target prim path of the arc.
626 
627  /// The invalid layer offset expressed on the arc.
629 
631 
632 private:
633  /// Constructor is private. Use New() instead.
635 };
636 
637 ///////////////////////////////////////////////////////////////////////////////
638 
639 // Forward declarations:
641 typedef std::shared_ptr<PcpErrorInvalidSublayerOwnership>
643 
644 /// \class PcpErrorInvalidSublayerOwnership
645 ///
646 /// Sibling layers that have the same owner.
647 ///
649 public:
650  /// Returns a new error object.
652  /// Destructor.
654  /// Converts error to string message.
655  PCP_API std::string ToString() const override;
656 
657  std::string owner;
658  SdfLayerHandle layer;
659  SdfLayerHandleVector sublayers;
660 
661 private:
662  /// Constructor is private. Use New() instead.
664 };
665 
666 ///////////////////////////////////////////////////////////////////////////////
667 
668 // Forward declarations:
670 typedef std::shared_ptr<PcpErrorInvalidSublayerPath>
672 
673 /// \class PcpErrorInvalidSublayerPath
674 ///
675 /// Asset paths that could not be both resolved and loaded.
676 ///
678 public:
679  /// Returns a new error object.
681  /// Destructor.
683  /// Converts error to string message.
684  PCP_API std::string ToString() const override;
685 
686  SdfLayerHandle layer;
687  std::string sublayerPath;
688  std::string messages;
689 
690 private:
691  /// Constructor is private. Use New() instead.
693 };
694 
695 ///////////////////////////////////////////////////////////////////////////////
696 
697 // Forward declarations:
699 typedef std::shared_ptr<PcpErrorRelocationBase>
701 
702 /// \class PcpErrorRelocationBase
703 ///
704 /// Base class for composition errors related to relocates.
705 ///
707 public:
708  /// Destructor.
709  PCP_API ~PcpErrorRelocationBase() override;
710 
711 protected:
713 };
714 
715 ///////////////////////////////////////////////////////////////////////////////
716 
717 // Forward declarations:
719 typedef std::shared_ptr<PcpErrorInvalidAuthoredRelocation>
721 
722 /// \class PcpErrorInvalidAuthoredRelocation
723 ///
724 /// Invalid authored relocation found in a relocates field.
725 ///
727 public:
728  /// Returns a new error object.
730  /// Destructor.
732  /// Converts error to string message.
733  PCP_API std::string ToString() const override;
734 
735  /// The source path of the invalid relocation.
737  /// The target path of the invalid relocation.
739  /// The layer containing the authored relocates.
740  SdfLayerHandle layer;
741  /// The path to the prim where the relocates is authored.
743 
744  /// Additional messages about the error.
745  std::string messages;
746 
747 private:
749 };
750 
751 ///////////////////////////////////////////////////////////////////////////////
752 
753 // Forward declarations:
755 typedef std::shared_ptr<PcpErrorInvalidConflictingRelocation>
757 
758 /// \class PcpErrorInvalidConflictingRelocation
759 ///
760 /// Relocation conflicts with another relocation in the layer stack.
761 ///
763 public:
764  /// Returns a new error object.
766  /// Destructor.
768  /// Converts error to string message.
769  PCP_API std::string ToString() const override;
770 
771  /// The source path of the invalid relocation.
773  /// The target path of the invalid relocation.
775  /// The layer containing the authored relocates.
776  SdfLayerHandle layer;
777  /// The path to the prim where the relocates is authored.
779 
780  /// The source path of the relocation this conflicts with.
782  /// The target path of the relocation this conflicts with.
784  /// The layer containing the authored relocation this conflicts with.
785  SdfLayerHandle conflictLayer;
786  /// The path to the prim where the relocation this conflicts with is authored.
788 
789  /// Enumeration of reasons a relocate can be in conflict with another
790  /// relocate.
791  enum class ConflictReason {
796  };
797 
798  /// The reason the relocate is a conflict.
800 
801 private:
803 };
804 
805 ///////////////////////////////////////////////////////////////////////////////
806 
807 // Forward declarations:
809 typedef std::shared_ptr<PcpErrorInvalidSameTargetRelocations>
811 
812 /// \class PcpErrorInvalidSameTargetRelocations
813 ///
814 /// Multiple relocations in the layer stack have the same target.
815 ///
817 public:
818  /// Returns a new error object.
820  /// Destructor.
822  /// Converts error to string message.
823  PCP_API std::string ToString() const override;
824 
825  /// The target path of the multiple invalid relocations.
827 
828  /// Info about each relocate source that has the same target path.
830  /// The source path of the invalid relocation.
832  /// The layer containing the authored relocates.
833  SdfLayerHandle layer;
834  /// The path to the prim where the relocates is authored.
836  };
837 
838  /// The sources of all relocates that relocate to the target path.
839  std::vector<RelocationSource> sources;
840 
841 private:
843 };
844 
845 ///////////////////////////////////////////////////////////////////////////////
846 
847 // Forward declarations:
849 typedef std::shared_ptr<PcpErrorOpinionAtRelocationSource>
851 
852 /// \class PcpErrorOpinionAtRelocationSource
853 ///
854 /// Opinions were found at a relocation source path.
855 ///
857 public:
858  /// Returns a new error object.
860  /// Destructor.
862  /// Converts error to string message.
863  PCP_API std::string ToString() const override;
864 
865  SdfLayerHandle layer;
867 
868 private:
869  /// Constructor is private. Use New() instead.
871 };
872 
873 ///////////////////////////////////////////////////////////////////////////////
874 
875 // Forward declarations:
877 typedef std::shared_ptr<PcpErrorPrimPermissionDenied>
879 
880 /// \class PcpErrorPrimPermissionDenied
881 ///
882 /// Layers with illegal opinions about private prims.
883 ///
885 public:
886  /// Returns a new error object.
888  /// Destructor.
890  /// Converts error to string message.
891  PCP_API std::string ToString() const override;
892 
893  /// The site where the invalid arc was expressed.
895  /// The private, invalid target of the arc.
897 
898 private:
899  /// Constructor is private. Use New() instead.
901 };
902 
903 ///////////////////////////////////////////////////////////////////////////////
904 
905 // Forward declarations:
907 typedef std::shared_ptr<PcpErrorPropertyPermissionDenied>
909 
910 /// \class PcpErrorPropertyPermissionDenied
911 ///
912 /// Layers with illegal opinions about private properties.
913 ///
915 public:
916  /// Returns a new error object.
918  /// Destructor.
920  /// Converts error to string message.
921  PCP_API std::string ToString() const override;
922 
925  std::string layerPath;
926 
927 private:
928  /// Constructor is private. Use New() instead.
930 };
931 
932 ///////////////////////////////////////////////////////////////////////////////
933 
934 // Forward declarations:
936 typedef std::shared_ptr<PcpErrorSublayerCycle> PcpErrorSublayerCyclePtr;
937 
938 /// \class PcpErrorSublayerCycle
939 ///
940 /// Layers that recursively sublayer themselves.
941 ///
943 public:
944  /// Returns a new error object.
945  static PcpErrorSublayerCyclePtr New();
946  /// Destructor.
947  PCP_API ~PcpErrorSublayerCycle() override;
948  /// Converts error to string message.
949  PCP_API std::string ToString() const override;
950 
951  SdfLayerHandle layer;
952  SdfLayerHandle sublayer;
953 
954 private:
955  /// Constructor is private. Use New() instead.
957 };
958 
959 ///////////////////////////////////////////////////////////////////////////////
960 
961 // Forward declarations:
963 typedef std::shared_ptr<PcpErrorTargetPermissionDenied>
965 
966 /// \class PcpErrorTargetPermissionDenied
967 ///
968 /// Paths with illegal opinions about private targets.
969 ///
971 public:
972  /// Returns a new error object.
974  /// Destructor.
976  /// Converts error to string message.
977  PCP_API std::string ToString() const override;
978 
979 private:
980  /// Constructor is private. Use New() instead.
982 };
983 
984 ///////////////////////////////////////////////////////////////////////////////
985 
986 // Forward declarations:
988 typedef std::shared_ptr<PcpErrorUnresolvedPrimPath>
990 
991 /// \class PcpErrorUnresolvedPrimPath
992 ///
993 /// Asset paths that could not be both resolved and loaded.
994 ///
996 public:
997  /// Returns a new error object.
999  /// Destructor.
1001  /// Converts error to string message.
1002  PCP_API std::string ToString() const override;
1003 
1004  /// The site where the invalid arc was expressed.
1006 
1007  /// The source layer of the spec that caused this arc to be introduced.
1008  /// This may be a sublayer of the site.
1009  SdfLayerHandle sourceLayer;
1010 
1011  /// The target layer of the arc.
1012  SdfLayerHandle targetLayer;
1013 
1014  /// The prim path that cannot be resolved on the target layer stack.
1016 
1018 
1019 private:
1020  /// Constructor is private. Use New() instead.
1022 };
1023 
1024 ///////////////////////////////////////////////////////////////////////////////
1025 
1026 // Forward declarations:
1028 typedef std::shared_ptr<PcpErrorVariableExpressionError>
1030 
1031 /// \class PcpErrorVariableExpressionError
1032 ///
1033 /// Error when evaluating a variable expression.
1034 ///
1036 public:
1038 
1040 
1041  PCP_API std::string ToString() const override;
1042 
1043  /// The expression that was evaluated.
1044  std::string expression;
1045 
1046  /// The error generated during evaluation.
1047  std::string expressionError;
1048 
1049  /// The context where the expression was authored, e.g.
1050  /// "sublayer", "reference", etc.
1051  std::string context;
1052 
1053  /// The source layer where the expression was authored.
1054  SdfLayerHandle sourceLayer;
1055 
1056  /// The source path where the expression was authored. This
1057  /// may be the absolute root path.
1059 
1060 private:
1061  /// Constructor is private. Use New() instead.
1063 };
1064 
1065 ///////////////////////////////////////////////////////////////////////////////
1066 
1067 /// Raise the given errors as runtime errors.
1068 PCP_API
1069 void PcpRaiseErrors(const PcpErrorVector &errors);
1070 
1072 
1073 #endif // PXR_USD_PCP_ERRORS_H
PcpErrorTargetPathBase(PcpErrorType errorType)
SdfPath conflictTargetPath
The target path of the relocation this conflicts with.
Definition: errors.h:783
PCP_API ~PcpErrorInvalidAssetPath() override
Destructor.
PCP_API ~PcpErrorInconsistentAttributeType() override
Destructor.
SdfPath composedTargetPath
Definition: errors.h:480
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:347
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:173
SdfLayerHandle sourceLayer
Definition: errors.h:1009
std::shared_ptr< PcpErrorMutedAssetPath > PcpErrorMutedAssetPathPtr
Definition: errors.h:429
PCP_API ~PcpErrorInvalidSublayerOwnership() override
Destructor.
Info about each relocate source that has the same target path.
Definition: errors.h:829
SdfPath owningPath
The path to the prim where the relocates is authored.
Definition: errors.h:778
std::shared_ptr< PcpErrorInvalidAssetPath > PcpErrorInvalidAssetPathPtr
Definition: errors.h:404
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorOpinionAtRelocationSource() override
Destructor.
SdfLayerHandle layer
The layer containing the authored relocates.
Definition: errors.h:740
std::string conflictingLayerIdentifier
The identifier of the layer with the conflicting property spec.
Definition: errors.h:224
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.
SdfPath sourcePath
The source path of the invalid relocation.
Definition: errors.h:736
static PcpErrorInconsistentAttributeTypePtr New()
Returns a new error object.
static PcpErrorTargetPermissionDeniedPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorTargetPermissionDenied > PcpErrorTargetPermissionDeniedPtr
Definition: errors.h:962
PCP_API std::string ToString() const override
Converts error to string message.
std::vector< RelocationSource > sources
The sources of all relocates that relocate to the target path.
Definition: errors.h:839
SdfPath owningPath
The path to the property where the target was authored.
Definition: errors.h:470
PCP_API ~PcpErrorInvalidAssetPathBase() override
Destructor.
std::string assetPath
The target asset path of the arc as authored.
Definition: errors.h:382
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:468
PcpErrorType
Definition: errors.h:28
SdfVariability conflictingVariability
The variability of the conflicting spec.
Definition: errors.h:319
std::shared_ptr< PcpErrorPropertyPermissionDenied > PcpErrorPropertyPermissionDeniedPtr
Definition: errors.h:906
static PcpErrorInconsistentAttributeVariabilityPtr New()
Returns a new error object.
SdfPath primPath
The target prim path of the arc that is invalid.
Definition: errors.h:350
std::shared_ptr< PcpErrorInvalidSublayerOwnership > PcpErrorInvalidSublayerOwnershipPtr
Definition: errors.h:640
std::shared_ptr< PcpErrorOpinionAtRelocationSource > PcpErrorOpinionAtRelocationSourcePtr
Definition: errors.h:848
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerHandleVector sublayers
Definition: errors.h:659
PCP_API ~PcpErrorTargetPermissionDenied() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorInvalidTargetPath() override
Destructor.
std::shared_ptr< PcpErrorInvalidSameTargetRelocations > PcpErrorInvalidSameTargetRelocationsPtr
Definition: errors.h:808
std::shared_ptr< PcpErrorInconsistentPropertyType > PcpErrorInconsistentPropertyTypePtr
Definition: errors.h:236
SdfLayerHandle layer
The layer containing the authored relocates.
Definition: errors.h:833
static PcpErrorInvalidSameTargetRelocationsPtr New()
Returns a new error object.
PCP_API ~PcpErrorInvalidReferenceOffset() override
Destructor.
Definition: site.h:28
PCP_API ~PcpErrorInconsistentPropertyType() override
Destructor.
virtual std::string ToString() const =0
Converts error to string message.
std::shared_ptr< PcpErrorInvalidTargetPath > PcpErrorInvalidTargetPathPtr
Definition: errors.h:544
SdfPath unresolvedPath
The prim path that cannot be resolved on the target layer stack.
Definition: errors.h:1015
virtual PCP_API ~PcpErrorBase()
Destructor.
const PcpErrorType errorType
The error code.
Definition: errors.h:79
PcpSite targetSite
The target site of the invalid arc which is a prohibited child.
Definition: errors.h:175
std::shared_ptr< PcpErrorInvalidSublayerOffset > PcpErrorInvalidSublayerOffsetPtr
Definition: errors.h:569
SdfSpecType definingSpecType
The type of the defining spec.
Definition: errors.h:255
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:221
std::shared_ptr< PcpErrorInvalidConflictingRelocation > PcpErrorInvalidConflictingRelocationPtr
Definition: errors.h:754
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:1054
SdfLayerHandle layer
Definition: errors.h:586
SdfPath sourcePath
The source path of the spec that caused this arc to be introduced.
Definition: errors.h:619
SdfLayerHandle layer
The layer containing the authored relocates.
Definition: errors.h:776
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:1044
PCP_API std::string ToString() const override
Converts error to string message.
std::shared_ptr< PcpErrorBase > PcpErrorBasePtr
Definition: errors.h:63
std::shared_ptr< PcpErrorInvalidAuthoredRelocation > PcpErrorInvalidAuthoredRelocationPtr
Definition: errors.h:718
PCP_API ~PcpErrorInvalidInstanceTargetPath() override
Destructor.
PCP_API ~PcpErrorInvalidExternalTargetPath() override
Destructor.
static PcpErrorInvalidReferenceOffsetPtr New()
Returns a new error object.
PcpArcType arcType
The type of arc.
Definition: errors.h:180
static PcpErrorSublayerCyclePtr New()
Returns a new error object.
SdfLayerHandle layer
Definition: errors.h:686
PcpErrorBase(PcpErrorType errorType)
Constructor.
PCP_API ~PcpErrorInvalidAuthoredRelocation() override
Destructor.
TfToken definingValueType
The value type from the defining spec.
Definition: errors.h:286
static PcpErrorInvalidPrimPathPtr New()
Returns a new error object.
static PcpErrorInvalidTargetPathPtr New()
Returns a new error object.
Definition: token.h:70
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerHandle sublayer
Definition: errors.h:952
PCP_API ~PcpErrorArcPermissionDenied() override
Destructor.
PCP_API ~PcpErrorPropertyPermissionDenied() override
Destructor.
PCP_API ~PcpErrorUnresolvedPrimPath() override
Destructor.
SdfLayerHandle sourceLayer
Definition: errors.h:354
std::shared_ptr< PcpErrorInvalidReferenceOffset > PcpErrorInvalidReferenceOffsetPtr
Definition: errors.h:598
static PcpErrorCapacityExceededPtr New(PcpErrorType errorType)
Returns a new error object.
std::shared_ptr< PcpErrorTargetPathBase > PcpErrorTargetPathBasePtr
Definition: errors.h:454
SdfPath targetPath
The target path of the invalid relocation.
Definition: errors.h:738
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath sourcePath
The source path of the invalid relocation.
Definition: errors.h:831
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath sourcePath
The source path of the invalid relocation.
Definition: errors.h:772
SdfPath owningPath
The path to the prim where the relocates is authored.
Definition: errors.h:835
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:317
SdfPath targetPath
The target path of the invalid relocation.
Definition: errors.h:774
PCP_API ~PcpErrorTargetPathBase() override
Destructor.
std::shared_ptr< PcpErrorInconsistentAttributeVariability > PcpErrorInconsistentAttributeVariabilityPtr
Definition: errors.h:298
std::shared_ptr< PcpErrorArcCycle > PcpErrorArcCyclePtr
Definition: errors.h:95
PCP_API ~PcpErrorCapacityExceeded() override
Destructor.
SdfLayerHandle sublayer
Definition: errors.h:587
PCP_API ~PcpErrorInvalidConflictingRelocation() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerOffset offset
Definition: errors.h:588
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:896
std::shared_ptr< PcpErrorInvalidExternalTargetPath > PcpErrorInvalidExternalTargetPathPtr
Definition: errors.h:515
std::shared_ptr< PcpErrorInvalidSublayerPath > PcpErrorInvalidSublayerPathPtr
Definition: errors.h:669
static PcpErrorInconsistentPropertyTypePtr New()
Returns a new error object.
std::string expressionError
The error generated during evaluation.
Definition: errors.h:1047
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:489
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:894
SdfPath conflictingSpecPath
The path of the conflicting property spec.
Definition: errors.h:226
std::shared_ptr< PcpErrorCapacityExceeded > PcpErrorCapacityExceededPtr
Definition: errors.h:190
static PcpErrorPrimPermissionDeniedPtr New()
Returns a new error object.
SdfSpecType conflictingSpecType
The type of the conflicting spec.
Definition: errors.h:257
std::shared_ptr< PcpErrorPrimPermissionDenied > PcpErrorPrimPermissionDeniedPtr
Definition: errors.h:876
static PcpErrorInvalidAssetPathPtr New()
Returns a new error object.
std::string definingLayerIdentifier
The identifier of the layer with the defining property spec.
Definition: errors.h:219
std::string assetPath
Target asset path of the arc.
Definition: errors.h:622
Definition: path.h:273
PCP_API ~PcpErrorInconsistentPropertyBase() override
Destructor.
PcpErrorRelocationBase(PcpErrorType errorType)
std::shared_ptr< PcpErrorArcToProhibitedChild > PcpErrorArcToProhibitedChildPtr
Definition: errors.h:154
SdfPath conflictSourcePath
The source path of the relocation this conflicts with.
Definition: errors.h:781
static PcpErrorInvalidAuthoredRelocationPtr New()
Returns a new error object.
std::vector< PcpErrorBasePtr > PcpErrorVector
Definition: errors.h:65
SdfLayerHandle targetLayer
The target layer of the arc.
Definition: errors.h:1012
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:628
std::shared_ptr< PcpErrorSublayerCycle > PcpErrorSublayerCyclePtr
Definition: errors.h:935
SdfVariability
Definition: types.h:156
static PcpErrorVariableExpressionErrorPtr New()
PCP_API std::string ToString() const override
Converts error to string message.
SdfLayerHandle layer
Definition: errors.h:951
static PcpErrorInvalidExternalTargetPathPtr New()
Returns a new error object.
SdfPath targetPath
Target prim path of the arc.
Definition: errors.h:625
PcpArcType arcType
Definition: errors.h:356
std::shared_ptr< PcpErrorInconsistentAttributeType > PcpErrorInconsistentAttributeTypePtr
Definition: errors.h:267
PCP_API std::string ToString() const override
Converts error to string message.
TfToken conflictingValueType
The value type from the conflicting spec.
Definition: errors.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
static PcpErrorInvalidConflictingRelocationPtr New()
Returns a new error object.
std::string messages
Additional provided error information.
Definition: errors.h:394
SdfSpecType
Definition: types.h:68
PCP_API std::string ToString() const override
Converts error to string message.
std::string sublayerPath
Definition: errors.h:687
PcpErrorInconsistentPropertyBase(PcpErrorType errorType)
Constructor.
PCP_API std::string ToString() const override
Converts error to string message.
std::vector< PcpSiteTrackerSegment > PcpSiteTracker
Definition: types.h:111
PCP_API std::string ToString() const override
Converts error to string message.
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:142
PCP_API void PcpRaiseErrors(const PcpErrorVector &errors)
Raise the given errors as runtime errors.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
SdfPath conflictOwningPath
The path to the prim where the relocation this conflicts with is authored.
Definition: errors.h:787
std::shared_ptr< PcpErrorVariableExpressionError > PcpErrorVariableExpressionErrorPtr
Definition: errors.h:1027
static PcpErrorInvalidSublayerOffsetPtr New()
Returns a new error object.
PCP_API ~PcpErrorInvalidSameTargetRelocations() override
Destructor.
SdfSpecType ownerSpecType
The spec type of the property where the target was authored.
Definition: errors.h:472
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath targetPath
The target prim path of the arc.
Definition: errors.h:379
SdfPath owningPath
The path to the prim where the relocates is authored.
Definition: errors.h:742
static PcpErrorPropertyPermissionDeniedPtr New()
Returns a new error object.
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:140
static PcpErrorArcToProhibitedChildPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorInvalidAssetPathBase > PcpErrorInvalidAssetPathBasePtr
Definition: errors.h:366
std::shared_ptr< PcpErrorInvalidPrimPath > PcpErrorInvalidPrimPathPtr
Definition: errors.h:329
PCP_API ~PcpErrorInvalidSublayerPath() override
Destructor.
std::string messages
Additional messages about the error.
Definition: errors.h:745
PCP_API ~PcpErrorArcToProhibitedChild() override
Destructor.
std::string resolvedAssetPath
The resolved target asset path of the arc.
Definition: errors.h:385
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:376
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:144
SdfPath targetPath
The target path of the multiple invalid relocations.
Definition: errors.h:826
std::shared_ptr< PcpErrorUnresolvedPrimPath > PcpErrorUnresolvedPrimPathPtr
Definition: errors.h:987
SdfLayerHandle conflictLayer
The layer containing the authored relocation this conflicts with.
Definition: errors.h:785
std::shared_ptr< PcpErrorArcPermissionDenied > PcpErrorArcPermissionDeniedPtr
Definition: errors.h:121
PCP_API ~PcpErrorInvalidPrimPath() override
Destructor.
ConflictReason conflictReason
The reason the relocate is a conflict.
Definition: errors.h:799
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:111
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:1005
PCP_API ~PcpErrorInvalidSublayerOffset() override
Destructor.
PcpSite rootSite
Definition: errors.h:85
SdfLayerHandle sourceLayer
Definition: errors.h:389
PCP_API ~PcpErrorRelocationBase() override
Destructor.
PCP_API ~PcpErrorArcCycle() override
Destructor.
SdfLayerHandle layer
The layer containing the property where the target was authored.
Definition: errors.h:474
std::shared_ptr< PcpErrorRelocationBase > PcpErrorRelocationBasePtr
Definition: errors.h:698
SdfLayerHandle sourceLayer
The source layer of the spec that caused this arc to be introduced.
Definition: errors.h:616
PCP_API std::string ToString() const override
Converts error to string message.
#define PCP_API
Definition: api.h:23
PcpArcType
Definition: types.h:27