This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
errors.h
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
22PXR_NAMESPACE_OPEN_SCOPE
23
28enum PcpErrorType {
29 PcpErrorType_ArcCycle,
30 PcpErrorType_ArcPermissionDenied,
31 PcpErrorType_ArcToProhibitedChild,
32 PcpErrorType_IndexCapacityExceeded,
33 PcpErrorType_ArcCapacityExceeded,
34 PcpErrorType_ArcNamespaceDepthCapacityExceeded,
35 PcpErrorType_InconsistentPropertyType,
36 PcpErrorType_InconsistentAttributeType,
37 PcpErrorType_InconsistentAttributeVariability,
38 PcpErrorType_InternalAssetPath,
39 PcpErrorType_InvalidPrimPath,
40 PcpErrorType_InvalidAssetPath,
41 PcpErrorType_InvalidInstanceTargetPath,
42 PcpErrorType_InvalidExternalTargetPath,
43 PcpErrorType_InvalidTargetPath,
44 PcpErrorType_InvalidReferenceOffset,
45 PcpErrorType_InvalidSublayerOffset,
46 PcpErrorType_InvalidSublayerOwnership,
47 PcpErrorType_InvalidSublayerPath,
48 PcpErrorType_InvalidVariantSelection,
49 PcpErrorType_MutedAssetPath,
50 PcpErrorType_InvalidAuthoredRelocation,
51 PcpErrorType_InvalidConflictingRelocation,
52 PcpErrorType_InvalidSameTargetRelocations,
53 PcpErrorType_OpinionAtRelocationSource,
54 PcpErrorType_PrimPermissionDenied,
55 PcpErrorType_PropertyPermissionDenied,
56 PcpErrorType_SublayerCycle,
57 PcpErrorType_TargetPermissionDenied,
58 PcpErrorType_UnresolvedPrimPath,
59 PcpErrorType_VariableExpressionError
60};
61
62// Forward declarations:
63class PcpErrorBase;
64typedef std::shared_ptr<PcpErrorBase> PcpErrorBasePtr;
65typedef std::vector<PcpErrorBasePtr> PcpErrorVector;
66
72public:
74 PCP_API virtual ~PcpErrorBase();
76 virtual std::string ToString() const = 0;
77
79 const PcpErrorType errorType;
80
86
87protected:
89 explicit PcpErrorBase(PcpErrorType errorType);
90};
91
93
94// Forward declarations:
96typedef std::shared_ptr<PcpErrorArcCycle> PcpErrorArcCyclePtr;
97
103public:
105 static PcpErrorArcCyclePtr New();
107 PCP_API ~PcpErrorArcCycle() override;
109 PCP_API std::string ToString() const override;
110
111 PcpSiteTracker cycle;
112
113private:
116};
117
119
120// Forward declarations:
122typedef std::shared_ptr<PcpErrorArcPermissionDenied>
123 PcpErrorArcPermissionDeniedPtr;
124
131public:
133 static PcpErrorArcPermissionDeniedPtr New();
137 PCP_API std::string ToString() const override;
138
145
146private:
149};
150
152
153// Forward declarations:
155typedef std::shared_ptr<PcpErrorArcToProhibitedChild>
156 PcpErrorArcToProhibitedChildPtr;
157
164public:
166 static PcpErrorArcToProhibitedChildPtr New();
170 PCP_API std::string ToString() const override;
171
181
182private:
185};
186
188
189// Forward declarations:
191typedef std::shared_ptr<PcpErrorCapacityExceeded> PcpErrorCapacityExceededPtr;
192
198public:
200 static PcpErrorCapacityExceededPtr New(PcpErrorType errorType);
202 PCP_API ~PcpErrorCapacityExceeded() override;
204 PCP_API std::string ToString() const override;
205
206private:
209};
210
212
213class PcpErrorInconsistentPropertyBase : public PcpErrorBase {
214public:
216 PCP_API ~PcpErrorInconsistentPropertyBase() override;
217
219 std::string definingLayerIdentifier;
221 SdfPath definingSpecPath;
222
224 std::string conflictingLayerIdentifier;
226 SdfPath conflictingSpecPath;
227
228protected:
230 PcpErrorInconsistentPropertyBase(PcpErrorType errorType);
231};
232
234
235// Forward declarations:
237typedef std::shared_ptr<PcpErrorInconsistentPropertyType>
238 PcpErrorInconsistentPropertyTypePtr;
239
245 public PcpErrorInconsistentPropertyBase {
246public:
248 static PcpErrorInconsistentPropertyTypePtr New();
252 PCP_API std::string ToString() const override;
253
258
259private:
262};
263
265
266// Forward declarations:
268typedef std::shared_ptr<PcpErrorInconsistentAttributeType>
269 PcpErrorInconsistentAttributeTypePtr;
270
276 public PcpErrorInconsistentPropertyBase {
277public:
279 static PcpErrorInconsistentAttributeTypePtr New();
283 PCP_API std::string ToString() const override;
284
289
290private:
293};
294
296
297// Forward declarations:
299typedef std::shared_ptr<PcpErrorInconsistentAttributeVariability>
300 PcpErrorInconsistentAttributeVariabilityPtr;
301
307 public PcpErrorInconsistentPropertyBase {
308public:
310 static PcpErrorInconsistentAttributeVariabilityPtr New();
314 PCP_API std::string ToString() const override;
315
320
321private:
324};
325
327
328// Forward declarations:
330typedef std::shared_ptr<PcpErrorInvalidPrimPath>
331 PcpErrorInvalidPrimPathPtr;
332
338public:
340 static PcpErrorInvalidPrimPathPtr New();
342 PCP_API ~PcpErrorInvalidPrimPath() override;
344 PCP_API std::string ToString() const override;
345
348
351
354 SdfLayerHandle sourceLayer;
355
356 PcpArcType arcType;
357
358private:
361};
362
364
365// Forward declarations:
366class PcpErrorInvalidAssetPathBase;
367typedef std::shared_ptr<PcpErrorInvalidAssetPathBase>
368 PcpErrorInvalidAssetPathBasePtr;
369
370class PcpErrorInvalidAssetPathBase : public PcpErrorBase {
371public:
373 PCP_API ~PcpErrorInvalidAssetPathBase() override;
374
376 PcpSite site;
377
379 SdfPath targetPath;
380
382 std::string assetPath;
383
385 std::string resolvedAssetPath;
386
389 SdfLayerHandle sourceLayer;
390
391 PcpArcType arcType;
392
394 std::string messages;
395
396protected:
398 PcpErrorInvalidAssetPathBase(PcpErrorType errorType);
399};
400
402
403// Forward declarations:
405typedef std::shared_ptr<PcpErrorInvalidAssetPath>
406 PcpErrorInvalidAssetPathPtr;
407
412class PcpErrorInvalidAssetPath : public PcpErrorInvalidAssetPathBase {
413public:
415 static PcpErrorInvalidAssetPathPtr New();
417 PCP_API ~PcpErrorInvalidAssetPath() override;
419 PCP_API std::string ToString() const override;
420
421private:
424};
425
427
428// Forward declarations:
430typedef std::shared_ptr<PcpErrorMutedAssetPath>
431 PcpErrorMutedAssetPathPtr;
432
437class PcpErrorMutedAssetPath : public PcpErrorInvalidAssetPathBase {
438public:
440 static PcpErrorMutedAssetPathPtr New();
442 PCP_API ~PcpErrorMutedAssetPath() override;
444 PCP_API std::string ToString() const override;
445
446private:
449};
450
452
453// Forward declarations:
455typedef std::shared_ptr<PcpErrorTargetPathBase>
456 PcpErrorTargetPathBasePtr;
457
463public:
465 PCP_API ~PcpErrorTargetPathBase() override;
466
474 SdfLayerHandle layer;
475
481
482protected:
483 PcpErrorTargetPathBase(PcpErrorType errorType);
484};
485
487
488// Forward declarations:
490typedef std::shared_ptr<PcpErrorInvalidInstanceTargetPath>
491 PcpErrorInvalidInstanceTargetPathPtr;
492
499public:
501 static PcpErrorInvalidInstanceTargetPathPtr New();
505 PCP_API std::string ToString() const override;
506
507private:
510};
511
513
514// Forward declarations:
516typedef std::shared_ptr<PcpErrorInvalidExternalTargetPath>
517 PcpErrorInvalidExternalTargetPathPtr;
518
525public:
527 static PcpErrorInvalidExternalTargetPathPtr New();
531 PCP_API std::string ToString() const override;
532
533 PcpArcType ownerArcType;
534 SdfPath ownerIntroPath;
535
536private:
539};
540
542
543// Forward declarations:
545typedef std::shared_ptr<PcpErrorInvalidTargetPath>
546 PcpErrorInvalidTargetPathPtr;
547
553public:
555 static PcpErrorInvalidTargetPathPtr New();
557 PCP_API ~PcpErrorInvalidTargetPath() override;
559 PCP_API std::string ToString() const override;
560
561private:
564};
565
567
568// Forward declarations:
570typedef std::shared_ptr<PcpErrorInvalidSublayerOffset>
571 PcpErrorInvalidSublayerOffsetPtr;
572
578public:
580 static PcpErrorInvalidSublayerOffsetPtr New();
584 PCP_API std::string ToString() const override;
585
586 SdfLayerHandle layer;
587 SdfLayerHandle sublayer;
588 SdfLayerOffset offset;
589
590private:
593};
594
596
597// Forward declarations:
599typedef std::shared_ptr<PcpErrorInvalidReferenceOffset>
600 PcpErrorInvalidReferenceOffsetPtr;
601
607public:
609 static PcpErrorInvalidReferenceOffsetPtr New();
613 PCP_API std::string ToString() const override;
614
616 SdfLayerHandle sourceLayer;
617
620
622 std::string assetPath;
623
626
629
630 PcpArcType arcType;
631
632private:
635};
636
638
639// Forward declarations:
641typedef std::shared_ptr<PcpErrorInvalidSublayerOwnership>
642 PcpErrorInvalidSublayerOwnershipPtr;
643
649public:
651 static PcpErrorInvalidSublayerOwnershipPtr New();
655 PCP_API std::string ToString() const override;
656
657 std::string owner;
658 SdfLayerHandle layer;
659 SdfLayerHandleVector sublayers;
660
661private:
664};
665
667
668// Forward declarations:
670typedef std::shared_ptr<PcpErrorInvalidSublayerPath>
671 PcpErrorInvalidSublayerPathPtr;
672
678public:
680 static PcpErrorInvalidSublayerPathPtr New();
684 PCP_API std::string ToString() const override;
685
686 SdfLayerHandle layer;
687 std::string sublayerPath;
688 std::string messages;
689
690private:
693};
694
696
697// Forward declarations:
699typedef std::shared_ptr<PcpErrorRelocationBase>
700 PcpErrorRelocationBasePtr;
701
707public:
709 PCP_API ~PcpErrorRelocationBase() override;
710
711protected:
712 PcpErrorRelocationBase(PcpErrorType errorType);
713};
714
716
717// Forward declarations:
719typedef std::shared_ptr<PcpErrorInvalidAuthoredRelocation>
720 PcpErrorInvalidAuthoredRelocationPtr;
721
727public:
729 static PcpErrorInvalidAuthoredRelocationPtr New();
733 PCP_API std::string ToString() const override;
734
740 SdfLayerHandle layer;
743
745 std::string messages;
746
747private:
749};
750
752
753// Forward declarations:
755typedef std::shared_ptr<PcpErrorInvalidConflictingRelocation>
756 PcpErrorInvalidConflictingRelocationPtr;
757
763public:
765 static PcpErrorInvalidConflictingRelocationPtr New();
769 PCP_API std::string ToString() const override;
770
776 SdfLayerHandle layer;
779
785 SdfLayerHandle conflictLayer;
788
791 enum class ConflictReason {
792 TargetIsConflictSource,
793 SourceIsConflictTarget,
794 TargetIsConflictSourceDescendant,
795 SourceIsConflictSourceDescendant
796 };
797
800
801private:
803};
804
806
807// Forward declarations:
809typedef std::shared_ptr<PcpErrorInvalidSameTargetRelocations>
810 PcpErrorInvalidSameTargetRelocationsPtr;
811
817public:
819 static PcpErrorInvalidSameTargetRelocationsPtr New();
823 PCP_API std::string ToString() const override;
824
827
833 SdfLayerHandle layer;
836 };
837
839 std::vector<RelocationSource> sources;
840
841private:
843};
844
846
847// Forward declarations:
849typedef std::shared_ptr<PcpErrorOpinionAtRelocationSource>
850 PcpErrorOpinionAtRelocationSourcePtr;
851
857public:
859 static PcpErrorOpinionAtRelocationSourcePtr New();
863 PCP_API std::string ToString() const override;
864
865 SdfLayerHandle layer;
866 SdfPath path;
867
868private:
871};
872
874
875// Forward declarations:
877typedef std::shared_ptr<PcpErrorPrimPermissionDenied>
878 PcpErrorPrimPermissionDeniedPtr;
879
885public:
887 static PcpErrorPrimPermissionDeniedPtr New();
891 PCP_API std::string ToString() const override;
892
897
898private:
901};
902
904
905// Forward declarations:
907typedef std::shared_ptr<PcpErrorPropertyPermissionDenied>
908 PcpErrorPropertyPermissionDeniedPtr;
909
915public:
917 static PcpErrorPropertyPermissionDeniedPtr New();
921 PCP_API std::string ToString() const override;
922
923 SdfPath propPath;
924 SdfSpecType propType;
925 std::string layerPath;
926
927private:
930};
931
933
934// Forward declarations:
936typedef std::shared_ptr<PcpErrorSublayerCycle> PcpErrorSublayerCyclePtr;
937
943public:
945 static PcpErrorSublayerCyclePtr New();
947 PCP_API ~PcpErrorSublayerCycle() override;
949 PCP_API std::string ToString() const override;
950
951 SdfLayerHandle layer;
952 SdfLayerHandle sublayer;
953
954private:
957};
958
960
961// Forward declarations:
963typedef std::shared_ptr<PcpErrorTargetPermissionDenied>
964 PcpErrorTargetPermissionDeniedPtr;
965
971public:
973 static PcpErrorTargetPermissionDeniedPtr New();
977 PCP_API std::string ToString() const override;
978
979private:
982};
983
985
986// Forward declarations:
988typedef std::shared_ptr<PcpErrorUnresolvedPrimPath>
989 PcpErrorUnresolvedPrimPathPtr;
990
996public:
998 static PcpErrorUnresolvedPrimPathPtr New();
1002 PCP_API std::string ToString() const override;
1003
1006
1009 SdfLayerHandle sourceLayer;
1010
1012 SdfLayerHandle targetLayer;
1013
1016
1017 PcpArcType arcType;
1018
1019private:
1022};
1023
1025
1026// Forward declarations:
1028typedef std::shared_ptr<PcpErrorVariableExpressionError>
1029 PcpErrorVariableExpressionErrorPtr;
1030
1036public:
1037 static PcpErrorVariableExpressionErrorPtr New();
1038
1039 PCP_API ~PcpErrorVariableExpressionError() override;
1040
1041 PCP_API std::string ToString() const override;
1042
1044 std::string expression;
1045
1047 std::string expressionError;
1048
1051 std::string context;
1052
1054 SdfLayerHandle sourceLayer;
1055
1059
1060private:
1063};
1064
1066
1068PCP_API
1069void PcpRaiseErrors(const PcpErrorVector &errors);
1070
1071PXR_NAMESPACE_CLOSE_SCOPE
1072
1073#endif // PXR_USD_PCP_ERRORS_H
Arcs between PcpNodes that form a cycle.
Definition: errors.h:102
static PcpErrorArcCyclePtr New()
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorArcCycle() override
Destructor.
Arcs that were not made between PcpNodes because of permission restrictions.
Definition: errors.h:130
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:140
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:142
static PcpErrorArcPermissionDeniedPtr New()
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorArcPermissionDenied() override
Destructor.
PcpArcType arcType
The type of arc.
Definition: errors.h:144
Arcs that were not made between PcpNodes because the target is a prohibited child prim of its parent ...
Definition: errors.h:163
PcpSite targetSite
The target site of the invalid arc which is a prohibited child.
Definition: errors.h:175
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:173
PCP_API ~PcpErrorArcToProhibitedChild() override
Destructor.
static PcpErrorArcToProhibitedChildPtr New()
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
PcpArcType arcType
The type of arc.
Definition: errors.h:180
PcpSite relocationSourceSite
The site of the node under targetSite that is a relocation source in its layer stack.
Definition: errors.h:178
Base class for all error types.
Definition: errors.h:71
virtual PCP_API ~PcpErrorBase()
Destructor.
virtual std::string ToString() const =0
Converts error to string message.
PcpSite rootSite
The site of the composed prim or property being computed when the error was encountered.
Definition: errors.h:85
PcpErrorBase(PcpErrorType errorType)
Constructor.
const PcpErrorType errorType
The error code.
Definition: errors.h:79
Exceeded the capacity for composition arcs at a single site.
Definition: errors.h:197
static PcpErrorCapacityExceededPtr New(PcpErrorType errorType)
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorCapacityExceeded() override
Destructor.
Attributes that have specs with conflicting definitions.
Definition: errors.h:276
TfToken definingValueType
The value type from the defining spec.
Definition: errors.h:286
TfToken conflictingValueType
The value type from the conflicting spec.
Definition: errors.h:288
PCP_API ~PcpErrorInconsistentAttributeType() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorInconsistentAttributeTypePtr New()
Returns a new error object.
Attributes that have specs with conflicting variability.
Definition: errors.h:307
SdfVariability definingVariability
The variability of the defining spec.
Definition: errors.h:317
PCP_API ~PcpErrorInconsistentAttributeVariability() override
Destructor.
static PcpErrorInconsistentAttributeVariabilityPtr New()
Returns a new error object.
SdfVariability conflictingVariability
The variability of the conflicting spec.
Definition: errors.h:319
PCP_API std::string ToString() const override
Converts error to string message.
Properties that have specs with conflicting definitions.
Definition: errors.h:245
static PcpErrorInconsistentPropertyTypePtr New()
Returns a new error object.
SdfSpecType definingSpecType
The type of the defining spec.
Definition: errors.h:255
SdfSpecType conflictingSpecType
The type of the conflicting spec.
Definition: errors.h:257
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorInconsistentPropertyType() override
Destructor.
Invalid asset paths used by references or payloads.
Definition: errors.h:412
PCP_API ~PcpErrorInvalidAssetPath() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorInvalidAssetPathPtr New()
Returns a new error object.
Invalid authored relocation found in a relocates field.
Definition: errors.h:726
SdfPath owningPath
The path to the prim where the relocates is authored.
Definition: errors.h:742
SdfLayerHandle layer
The layer containing the authored relocates.
Definition: errors.h:740
PCP_API ~PcpErrorInvalidAuthoredRelocation() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
std::string messages
Additional messages about the error.
Definition: errors.h:745
SdfPath sourcePath
The source path of the invalid relocation.
Definition: errors.h:736
static PcpErrorInvalidAuthoredRelocationPtr New()
Returns a new error object.
SdfPath targetPath
The target path of the invalid relocation.
Definition: errors.h:738
Relocation conflicts with another relocation in the layer stack.
Definition: errors.h:762
SdfPath conflictOwningPath
The path to the prim where the relocation this conflicts with is authored.
Definition: errors.h:787
SdfPath owningPath
The path to the prim where the relocates is authored.
Definition: errors.h:778
static PcpErrorInvalidConflictingRelocationPtr New()
Returns a new error object.
ConflictReason
Enumeration of reasons a relocate can be in conflict with another relocate.
Definition: errors.h:791
SdfPath conflictSourcePath
The source path of the relocation this conflicts with.
Definition: errors.h:781
SdfLayerHandle layer
The layer containing the authored relocates.
Definition: errors.h:776
ConflictReason conflictReason
The reason the relocate is a conflict.
Definition: errors.h:799
SdfLayerHandle conflictLayer
The layer containing the authored relocation this conflicts with.
Definition: errors.h:785
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath conflictTargetPath
The target path of the relocation this conflicts with.
Definition: errors.h:783
SdfPath sourcePath
The source path of the invalid relocation.
Definition: errors.h:772
SdfPath targetPath
The target path of the invalid relocation.
Definition: errors.h:774
PCP_API ~PcpErrorInvalidConflictingRelocation() override
Destructor.
Invalid target or connection path in some scope that points to an object outside of that scope.
Definition: errors.h:524
PCP_API ~PcpErrorInvalidExternalTargetPath() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorInvalidExternalTargetPathPtr New()
Returns a new error object.
Invalid target or connection path authored in an inherited class that points to an instance of that c...
Definition: errors.h:498
static PcpErrorInvalidInstanceTargetPathPtr New()
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorInvalidInstanceTargetPath() override
Destructor.
Invalid prim paths used by references or payloads.
Definition: errors.h:337
SdfPath primPath
The target prim path of the arc that is invalid.
Definition: errors.h:350
static PcpErrorInvalidPrimPathPtr New()
Returns a new error object.
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:347
SdfLayerHandle sourceLayer
The source layer of the spec that caused this arc to be introduced.
Definition: errors.h:354
PCP_API ~PcpErrorInvalidPrimPath() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
References or payloads that use invalid layer offsets.
Definition: errors.h:606
SdfLayerHandle sourceLayer
The source layer of the spec that caused this arc to be introduced.
Definition: errors.h:616
SdfLayerOffset offset
The invalid layer offset expressed on the arc.
Definition: errors.h:628
static PcpErrorInvalidReferenceOffsetPtr New()
Returns a new error object.
std::string assetPath
Target asset path of the arc.
Definition: errors.h:622
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath sourcePath
The source path of the spec that caused this arc to be introduced.
Definition: errors.h:619
SdfPath targetPath
Target prim path of the arc.
Definition: errors.h:625
PCP_API ~PcpErrorInvalidReferenceOffset() override
Destructor.
Multiple relocations in the layer stack have the same target.
Definition: errors.h:816
std::vector< RelocationSource > sources
The sources of all relocates that relocate to the target path.
Definition: errors.h:839
PCP_API ~PcpErrorInvalidSameTargetRelocations() override
Destructor.
SdfPath owningPath
The path to the prim where the relocates is authored.
Definition: errors.h:835
SdfLayerHandle layer
The layer containing the authored relocates.
Definition: errors.h:833
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
SdfPath targetPath
The target path of the multiple invalid relocations.
Definition: errors.h:826
static PcpErrorInvalidSameTargetRelocationsPtr New()
Returns a new error object.
Info about each relocate source that has the same target path.
Definition: errors.h:829
Sublayers that use invalid layer offsets.
Definition: errors.h:577
PCP_API ~PcpErrorInvalidSublayerOffset() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorInvalidSublayerOffsetPtr New()
Returns a new error object.
Sibling layers that have the same owner.
Definition: errors.h:648
PCP_API ~PcpErrorInvalidSublayerOwnership() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorInvalidSublayerOwnershipPtr New()
Returns a new error object.
Asset paths that could not be both resolved and loaded.
Definition: errors.h:677
PCP_API ~PcpErrorInvalidSublayerPath() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorInvalidSublayerPathPtr New()
Returns a new error object.
Invalid target or connection path.
Definition: errors.h:552
PCP_API ~PcpErrorInvalidTargetPath() override
Destructor.
static PcpErrorInvalidTargetPathPtr New()
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
Muted asset paths used by references or payloads.
Definition: errors.h:437
PCP_API std::string ToString() const override
Converts error to string message.
PCP_API ~PcpErrorMutedAssetPath() override
Destructor.
static PcpErrorMutedAssetPathPtr New()
Returns a new error object.
Opinions were found at a relocation source path.
Definition: errors.h:856
PCP_API ~PcpErrorOpinionAtRelocationSource() override
Destructor.
static PcpErrorOpinionAtRelocationSourcePtr New()
Returns a new error object.
PCP_API std::string ToString() const override
Converts error to string message.
Layers with illegal opinions about private prims.
Definition: errors.h:884
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:894
PCP_API ~PcpErrorPrimPermissionDenied() override
Destructor.
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:896
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorPrimPermissionDeniedPtr New()
Returns a new error object.
Layers with illegal opinions about private properties.
Definition: errors.h:914
static PcpErrorPropertyPermissionDeniedPtr New()
Returns a new error object.
PCP_API ~PcpErrorPropertyPermissionDenied() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
Base class for composition errors related to relocates.
Definition: errors.h:706
PCP_API ~PcpErrorRelocationBase() override
Destructor.
Layers that recursively sublayer themselves.
Definition: errors.h:942
PCP_API ~PcpErrorSublayerCycle() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorSublayerCyclePtr New()
Returns a new error object.
Base class for composition errors related to target or connection paths.
Definition: errors.h:462
SdfPath owningPath
The path to the property where the target was authored.
Definition: errors.h:470
SdfLayerHandle layer
The layer containing the property where the target was authored.
Definition: errors.h:474
PCP_API ~PcpErrorTargetPathBase() override
Destructor.
SdfPath composedTargetPath
The target or connection path in the composed scene.
Definition: errors.h:480
SdfSpecType ownerSpecType
The spec type of the property where the target was authored.
Definition: errors.h:472
SdfPath targetPath
The invalid target or connection path that was authored.
Definition: errors.h:468
Paths with illegal opinions about private targets.
Definition: errors.h:970
static PcpErrorTargetPermissionDeniedPtr New()
Returns a new error object.
PCP_API ~PcpErrorTargetPermissionDenied() override
Destructor.
PCP_API std::string ToString() const override
Converts error to string message.
Asset paths that could not be both resolved and loaded.
Definition: errors.h:995
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:1005
PCP_API ~PcpErrorUnresolvedPrimPath() override
Destructor.
SdfLayerHandle targetLayer
The target layer of the arc.
Definition: errors.h:1012
SdfLayerHandle sourceLayer
The source layer of the spec that caused this arc to be introduced.
Definition: errors.h:1009
PCP_API std::string ToString() const override
Converts error to string message.
static PcpErrorUnresolvedPrimPathPtr New()
Returns a new error object.
SdfPath unresolvedPath
The prim path that cannot be resolved on the target layer stack.
Definition: errors.h:1015
Error when evaluating a variable expression.
Definition: errors.h:1035
SdfLayerHandle sourceLayer
The source layer where the expression was authored.
Definition: errors.h:1054
std::string expression
The expression that was evaluated.
Definition: errors.h:1044
PCP_API std::string ToString() const override
Converts error to string message.
SdfPath sourcePath
The source path where the expression was authored.
Definition: errors.h:1058
std::string expressionError
The error generated during evaluation.
Definition: errors.h:1047
std::string context
The context where the expression was authored, e.g.
Definition: errors.h:1051
A site specifies a path in a layer stack of scene description.
Definition: site.h:29
Represents a time offset and scale between layers.
Definition: layerOffset.h:44
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
PcpArcType
Describes the type of arc connecting two nodes in the prim index.
Definition: types.h:27
std::vector< PcpSiteTrackerSegment > PcpSiteTracker
Represents a single path through the composition tree.
Definition: types.h:111
SdfSpecType
An enum that specifies the type of an object.
Definition: types.h:68
SdfVariability
An enum that identifies variability types for attributes.
Definition: types.h:156