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 "pxr/base/tf/enum.h"
36 
37 #include <memory>
38 #include <string>
39 #include <vector>
40 
42 
43 // Forward declaration:
44 class PcpCache;
45 
46 /// \enum PcpErrorType
47 ///
48 /// Enum to indicate the type represented by a Pcp error.
49 ///
77 };
78 
79 // Forward declarations:
81 typedef std::shared_ptr<PcpErrorBase> PcpErrorBasePtr;
82 typedef std::vector<PcpErrorBasePtr> PcpErrorVector;
83 
84 /// \class PcpErrorBase
85 ///
86 /// Base class for all error types.
87 ///
88 class PcpErrorBase {
89 public:
90  /// Destructor.
91  PCP_API virtual ~PcpErrorBase();
92  /// Converts error to string message.
93  virtual std::string ToString() const = 0;
94 
95  /// The error code.
97 
98  /// The site of the composed prim or property being computed when
99  /// the error was encountered. (Note that some error types
100  /// contain an additional site to capture more specific information
101  /// about the site of the error.)
103 
104  /// Return true if this type of error should be reported at most
105  /// once for a given prim.
106  bool ShouldReportAtMostOnce() const {
107  // Capacity errors are reported at most once. (If these limits are
108  // reached, there is likely to be a very large number of whatever
109  // caused it.)
113  }
114 
115 protected:
116  /// Constructor.
118 };
119 
120 ///////////////////////////////////////////////////////////////////////////////
121 
122 // Forward declarations:
124 typedef std::shared_ptr<PcpErrorArcCycle> PcpErrorArcCyclePtr;
125 
126 /// \class PcpErrorArcCycle
127 ///
128 /// Arcs between PcpNodes that form a cycle.
129 ///
131 public:
132  /// Returns a new error object.
133  static PcpErrorArcCyclePtr New();
134  /// Destructor.
136  /// Converts error to string message.
137  PCP_API virtual std::string ToString() const;
138 
140 
141 private:
142  /// Constructor is private. Use New() instead.
144 };
145 
146 ///////////////////////////////////////////////////////////////////////////////
147 
148 // Forward declarations:
150 typedef std::shared_ptr<PcpErrorArcPermissionDenied>
152 
153 /// \class PcpErrorArcPermissionDenied
154 ///
155 /// Arcs that were not made between PcpNodes because of permission
156 /// restrictions.
157 ///
159 public:
160  /// Returns a new error object.
162  /// Destructor.
164  /// Converts error to string message.
165  PCP_API virtual std::string ToString() const;
166 
167  /// The site where the invalid arc was expressed.
169  /// The private, invalid target of the arc.
171  /// The type of arc.
173 
174 private:
175  /// Constructor is private. Use New() instead.
177 };
178 
179 ///////////////////////////////////////////////////////////////////////////////
180 
181 // Forward declarations:
183 typedef std::shared_ptr<PcpErrorCapacityExceeded> PcpErrorCapacityExceededPtr;
184 
185 /// \class PcpErrorCapacityExceeded
186 ///
187 /// Exceeded the capacity for composition arcs at a single site.
188 ///
190 public:
191  /// Returns a new error object.
193  /// Destructor.
195  /// Converts error to string message.
196  PCP_API virtual std::string ToString() const;
197 
198 private:
199  /// Constructor is private. Use New() instead.
201 };
202 
203 ///////////////////////////////////////////////////////////////////////////////
204 
206 public:
207  /// Destructor.
209 
210  /// The identifier of the layer with the defining property spec.
212  /// The path of the defining property spec.
214 
215  /// The identifier of the layer with the conflicting property spec.
217  /// The path of the conflicting property spec.
219 
220 protected:
221  /// Constructor.
223 };
224 
225 ///////////////////////////////////////////////////////////////////////////////
226 
227 // Forward declarations:
229 typedef std::shared_ptr<PcpErrorInconsistentPropertyType>
231 
232 /// \class PcpErrorInconsistentPropertyType
233 ///
234 /// Properties that have specs with conflicting definitions.
235 ///
238 public:
239  /// Returns a new error object.
241  /// Destructor.
243  /// Converts error to string message.
244  PCP_API virtual std::string ToString() const;
245 
246  /// The type of the defining spec.
248  /// The type of the conflicting spec.
250 
251 private:
252  /// Constructor is private. Use New() instead.
254 };
255 
256 ///////////////////////////////////////////////////////////////////////////////
257 
258 // Forward declarations:
260 typedef std::shared_ptr<PcpErrorInconsistentAttributeType>
262 
263 /// \class PcpErrorInconsistentAttributeType
264 ///
265 /// Attributes that have specs with conflicting definitions.
266 ///
269 public:
270  /// Returns a new error object.
272  /// Destructor.
274  /// Converts error to string message.
275  PCP_API virtual std::string ToString() const;
276 
277  /// The value type from the defining spec.
279  /// The value type from the conflicting spec.
281 
282 private:
283  /// Constructor is private. Use New() instead.
285 };
286 
287 ///////////////////////////////////////////////////////////////////////////////
288 
289 // Forward declarations:
291 typedef std::shared_ptr<PcpErrorInconsistentAttributeVariability>
293 
294 /// \class PcpErrorInconsistentAttributeVariability
295 ///
296 /// Attributes that have specs with conflicting variability.
297 ///
300 public:
301  /// Returns a new error object.
303  /// Destructor.
305  /// Converts error to string message.
306  PCP_API virtual std::string ToString() const;
307 
308  /// The variability of the defining spec.
310  /// The variability of the conflicting spec.
312 
313 private:
314  /// Constructor is private. Use New() instead.
316 };
317 
318 ///////////////////////////////////////////////////////////////////////////////
319 
320 // Forward declarations:
322 typedef std::shared_ptr<PcpErrorInternalAssetPath>
324 
325 /// \class PcpErrorInternalAssetPath
326 ///
327 /// Error about an arc that is prohibited due to being internal to an asset.
328 ///
330 public:
331  /// Returns a new error object.
333  /// Destructor.
335  /// Converts error to string message.
336  PCP_API virtual std::string ToString() const;
337 
338  /// The site where the invalid arc was expressed.
344 
345 private:
346  /// Constructor is private. Use New() instead.
348 };
349 
350 ///////////////////////////////////////////////////////////////////////////////
351 
352 // Forward declarations:
354 typedef std::shared_ptr<PcpErrorInvalidPrimPath>
356 
357 /// \class PcpErrorInvalidPrimPath
358 ///
359 /// Invalid prim paths used by references or payloads.
360 ///
362 public:
363  /// Returns a new error object.
365  /// Destructor.
367  /// Converts error to string message.
368  PCP_API virtual std::string ToString() const;
369 
370  /// The site where the invalid arc was expressed.
374 
375 private:
376  /// Constructor is private. Use New() instead.
378 };
379 
380 ///////////////////////////////////////////////////////////////////////////////
381 
382 // Forward declarations:
384 typedef std::shared_ptr<PcpErrorInvalidAssetPathBase>
386 
388 public:
389  /// Destructor.
391 
392  /// The site where the invalid arc was expressed.
398  SdfLayerHandle layer;
400 
401 protected:
402  /// Constructor.
404 };
405 
406 ///////////////////////////////////////////////////////////////////////////////
407 
408 // Forward declarations:
410 typedef std::shared_ptr<PcpErrorInvalidAssetPath>
412 
413 /// \class PcpErrorInvalidAssetPath
414 ///
415 /// Invalid asset paths used by references or payloads.
416 ///
418 public:
419  /// Returns a new error object.
421  /// Destructor.
423  /// Converts error to string message.
424  PCP_API virtual std::string ToString() const;
425 
426 private:
427  /// Constructor is private. Use New() instead.
429 };
430 
431 ///////////////////////////////////////////////////////////////////////////////
432 
433 // Forward declarations:
435 typedef std::shared_ptr<PcpErrorMutedAssetPath>
437 
438 /// \class PcpErrorMutedAssetPath
439 ///
440 /// Muted asset paths used by references or payloads.
441 ///
443 public:
444  /// Returns a new error object.
446  /// Destructor.
448  /// Converts error to string message.
449  PCP_API virtual std::string ToString() const;
450 
451 private:
452  /// Constructor is private. Use New() instead.
454 };
455 
456 ///////////////////////////////////////////////////////////////////////////////
457 
458 // Forward declarations:
460 typedef std::shared_ptr<PcpErrorTargetPathBase>
462 
463 /// \class PcpErrorTargetPathBase
464 ///
465 /// Base class for composition errors related to target or connection paths.
466 ///
468 public:
469  /// Destructor.
471 
472  /// The invalid target or connection path that was authored.
474  /// The path to the property where the target was authored.
476  /// The spec type of the property where the target was authored.
478  /// The layer containing the property where the target was authored.
479  SdfLayerHandle layer;
480 
481  /// The target or connection path in the composed scene.
482  /// If this path could not be translated to the composed scene
483  /// (e.g., in the case of an invalid external target path),
484  /// this path will be empty.
486 
487 protected:
489 };
490 
491 ///////////////////////////////////////////////////////////////////////////////
492 
493 // Forward declarations:
495 typedef std::shared_ptr<PcpErrorInvalidInstanceTargetPath>
497 
498 /// \class PcpErrorInvalidInstanceTargetPath
499 ///
500 /// Invalid target or connection path authored in an inherited
501 /// class that points to an instance of that class.
502 ///
504 public:
505  /// Returns a new error object.
507  /// Destructor.
509  /// Converts error to string message.
510  PCP_API virtual std::string ToString() const;
511 
512 private:
513  /// Constructor is private. Use New() instead.
515 };
516 
517 ///////////////////////////////////////////////////////////////////////////////
518 
519 // Forward declarations:
521 typedef std::shared_ptr<PcpErrorInvalidExternalTargetPath>
523 
524 /// \class PcpErrorInvalidExternalTargetPath
525 ///
526 /// Invalid target or connection path in some scope that points to
527 /// an object outside of that scope.
528 ///
530 public:
531  /// Returns a new error object.
533  /// Destructor.
535  /// Converts error to string message.
536  PCP_API virtual std::string ToString() const;
537 
540 
541 private:
542  /// Constructor is private. Use New() instead.
544 };
545 
546 ///////////////////////////////////////////////////////////////////////////////
547 
548 // Forward declarations:
550 typedef std::shared_ptr<PcpErrorInvalidTargetPath>
552 
553 /// \class PcpErrorInvalidTargetPath
554 ///
555 /// Invalid target or connection path.
556 ///
558 public:
559  /// Returns a new error object.
561  /// Destructor.
563  /// Converts error to string message.
564  PCP_API virtual std::string ToString() const;
565 
566 private:
567  /// Constructor is private. Use New() instead.
569 };
570 
571 ///////////////////////////////////////////////////////////////////////////////
572 
573 // Forward declarations:
575 typedef std::shared_ptr<PcpErrorInvalidSublayerOffset>
577 
578 /// \class PcpErrorInvalidSublayerOffset
579 ///
580 /// Sublayers that use invalid layer offsets.
581 ///
583 public:
584  /// Returns a new error object.
586  /// Destructor.
588  /// Converts error to string message.
589  PCP_API virtual std::string ToString() const;
590 
591  SdfLayerHandle layer;
592  SdfLayerHandle sublayer;
594 
595 private:
596  /// Constructor is private. Use New() instead.
598 };
599 
600 ///////////////////////////////////////////////////////////////////////////////
601 
602 // Forward declarations:
604 typedef std::shared_ptr<PcpErrorInvalidReferenceOffset>
606 
607 /// \class PcpErrorInvalidReferenceOffset
608 ///
609 /// Sublayers that use invalid layer offsets.
610 ///
612 public:
613  /// Returns a new error object.
615  /// Destructor.
617  /// Converts error to string message.
618  PCP_API virtual std::string ToString() const;
619 
620  SdfLayerHandle layer;
625 
626 private:
627  /// Constructor is private. Use New() instead.
629 };
630 
631 ///////////////////////////////////////////////////////////////////////////////
632 
633 // Forward declarations:
635 typedef std::shared_ptr<PcpErrorInvalidSublayerOwnership>
637 
638 /// \class PcpErrorInvalidSublayerOwnership
639 ///
640 /// Sibling layers that have the same owner.
641 ///
643 public:
644  /// Returns a new error object.
646  /// Destructor.
648  /// Converts error to string message.
649  PCP_API virtual std::string ToString() const;
650 
652  SdfLayerHandle layer;
653  SdfLayerHandleVector sublayers;
654 
655 private:
656  /// Constructor is private. Use New() instead.
658 };
659 
660 ///////////////////////////////////////////////////////////////////////////////
661 
662 // Forward declarations:
664 typedef std::shared_ptr<PcpErrorInvalidSublayerPath>
666 
667 /// \class PcpErrorInvalidSublayerPath
668 ///
669 /// Asset paths that could not be both resolved and loaded.
670 ///
672 public:
673  /// Returns a new error object.
675  /// Destructor.
677  /// Converts error to string message.
678  PCP_API virtual std::string ToString() const;
679 
680  SdfLayerHandle layer;
683 
684 private:
685  /// Constructor is private. Use New() instead.
687 };
688 
689 ///////////////////////////////////////////////////////////////////////////////
690 
691 // Forward declarations:
693 typedef std::shared_ptr<PcpErrorInvalidVariantSelection>
695 
696 /// \class PcpErrorInvalidVariantSelection
697 ///
698 /// Invalid variant selections.
699 ///
701 public:
702  /// Returns a new error object.
704  /// Destructor.
706  /// Converts error to string message.
707  PCP_API virtual std::string ToString() const;
708 
712 
713 private:
714  /// Constructor is private. Use New() instead.
716 };
717 
718 ///////////////////////////////////////////////////////////////////////////////
719 
720 // Forward declarations:
722 typedef std::shared_ptr<PcpErrorOpinionAtRelocationSource>
724 
725 /// \class PcpErrorOpinionAtRelocationSource
726 ///
727 /// Opinions were found at a relocation source path.
728 ///
730 public:
731  /// Returns a new error object.
733  /// Destructor.
735  /// Converts error to string message.
736  PCP_API virtual std::string ToString() const;
737 
738  SdfLayerHandle layer;
740 
741 private:
742  /// Constructor is private. Use New() instead.
744 };
745 
746 ///////////////////////////////////////////////////////////////////////////////
747 
748 // Forward declarations:
750 typedef std::shared_ptr<PcpErrorPrimPermissionDenied>
752 
753 /// \class PcpErrorPrimPermissionDenied
754 ///
755 /// Layers with illegal opinions about private prims.
756 ///
758 public:
759  /// Returns a new error object.
761  /// Destructor.
763  /// Converts error to string message.
764  PCP_API virtual std::string ToString() const;
765 
766  /// The site where the invalid arc was expressed.
768  /// The private, invalid target of the arc.
770 
771 private:
772  /// Constructor is private. Use New() instead.
774 };
775 
776 ///////////////////////////////////////////////////////////////////////////////
777 
778 // Forward declarations:
780 typedef std::shared_ptr<PcpErrorPropertyPermissionDenied>
782 
783 /// \class PcpErrorPropertyPermissionDenied
784 ///
785 /// Layers with illegal opinions about private properties.
786 ///
788 public:
789  /// Returns a new error object.
791  /// Destructor.
793  /// Converts error to string message.
794  PCP_API virtual std::string ToString() const;
795 
799 
800 private:
801  /// Constructor is private. Use New() instead.
803 };
804 
805 ///////////////////////////////////////////////////////////////////////////////
806 
807 // Forward declarations:
809 typedef std::shared_ptr<PcpErrorSublayerCycle> PcpErrorSublayerCyclePtr;
810 
811 /// \class PcpErrorSublayerCycle
812 ///
813 /// Layers that recursively sublayer themselves.
814 ///
816 public:
817  /// Returns a new error object.
818  static PcpErrorSublayerCyclePtr New();
819  /// Destructor.
821  /// Converts error to string message.
822  PCP_API virtual std::string ToString() const;
823 
824  SdfLayerHandle layer;
825  SdfLayerHandle sublayer;
826 
827 private:
828  /// Constructor is private. Use New() instead.
830 };
831 
832 ///////////////////////////////////////////////////////////////////////////////
833 
834 // Forward declarations:
836 typedef std::shared_ptr<PcpErrorTargetPermissionDenied>
838 
839 /// \class PcpErrorTargetPermissionDenied
840 ///
841 /// Paths with illegal opinions about private targets.
842 ///
844 public:
845  /// Returns a new error object.
847  /// Destructor.
849  /// Converts error to string message.
850  PCP_API virtual std::string ToString() const;
851 
852 private:
853  /// Constructor is private. Use New() instead.
855 };
856 
857 ///////////////////////////////////////////////////////////////////////////////
858 
859 // Forward declarations:
861 typedef std::shared_ptr<PcpErrorUnresolvedPrimPath>
863 
864 /// \class PcpErrorUnresolvedPrimPath
865 ///
866 /// Asset paths that could not be both resolved and loaded.
867 ///
869 public:
870  /// Returns a new error object.
872  /// Destructor.
874  /// Converts error to string message.
875  PCP_API virtual std::string ToString() const;
876 
877  /// The site where the invalid arc was expressed.
881 
882 private:
883  /// Constructor is private. Use New() instead.
885 };
886 
887 /// Raise the given errors as runtime errors.
888 PCP_API
889 void PcpRaiseErrors(const PcpErrorVector &errors);
890 
892 
893 #endif // PXR_USD_PCP_ERRORS_H
std::shared_ptr< PcpErrorBase > PcpErrorBasePtr
Definition: errors.h:80
PCP_API ~PcpErrorMutedAssetPath()
Destructor.
std::shared_ptr< PcpErrorInvalidVariantSelection > PcpErrorInvalidVariantSelectionPtr
Definition: errors.h:692
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorInvalidExternalTargetPath()
Destructor.
SdfPath composedTargetPath
Definition: errors.h:485
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:371
PCP_API void PcpRaiseErrors(const PcpErrorVector &errors)
Raise the given errors as runtime errors.
std::string conflictingLayerIdentifier
The identifier of the layer with the conflicting property spec.
Definition: errors.h:216
std::shared_ptr< PcpErrorPrimPermissionDenied > PcpErrorPrimPermissionDeniedPtr
Definition: errors.h:749
PCP_API ~PcpErrorInvalidInstanceTargetPath()
Destructor.
static PcpErrorInconsistentAttributeTypePtr New()
Returns a new error object.
PCP_API ~PcpErrorInvalidSublayerOffset()
Destructor.
std::shared_ptr< PcpErrorArcCycle > PcpErrorArcCyclePtr
Definition: errors.h:123
static PcpErrorTargetPermissionDeniedPtr New()
Returns a new error object.
SdfPath owningPath
The path to the property where the target was authored.
Definition: errors.h:475
PCP_API ~PcpErrorUnresolvedPrimPath()
Destructor.
PCP_API ~PcpErrorInvalidSublayerPath()
Destructor.
bool ShouldReportAtMostOnce() const
Definition: errors.h:106
static PcpErrorInvalidSublayerOwnershipPtr New()
Returns a new error object.
SdfPath targetPath
The invalid target or connection path that was authored.
Definition: errors.h:473
PCP_API ~PcpErrorInvalidAssetPath()
Destructor.
SdfVariability conflictingVariability
The variability of the conflicting spec.
Definition: errors.h:311
static PcpErrorInconsistentAttributeVariabilityPtr New()
Returns a new error object.
static PcpErrorInvalidVariantSelectionPtr New()
Returns a new error object.
SdfLayerHandleVector sublayers
Definition: errors.h:653
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorInconsistentAttributeVariability > PcpErrorInconsistentAttributeVariabilityPtr
Definition: errors.h:290
PCP_API ~PcpErrorArcPermissionDenied()
Destructor.
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorInvalidVariantSelection()
Destructor.
Definition: cache.h:93
std::shared_ptr< PcpErrorOpinionAtRelocationSource > PcpErrorOpinionAtRelocationSourcePtr
Definition: errors.h:721
PCP_API ~PcpErrorInvalidAssetPathBase()
Destructor.
Definition: site.h:46
Definition: enum.h:139
virtual std::string ToString() const =0
Converts error to string message.
virtual PCP_API ~PcpErrorBase()
Destructor.
std::string resolvedAssetPath
Definition: errors.h:342
std::shared_ptr< PcpErrorInvalidInstanceTargetPath > PcpErrorInvalidInstanceTargetPathPtr
Definition: errors.h:494
SdfSpecType definingSpecType
The type of the defining spec.
Definition: errors.h:247
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorPropertyPermissionDenied()
Destructor.
SdfPath definingSpecPath
The path of the defining property spec.
Definition: errors.h:213
std::shared_ptr< PcpErrorArcPermissionDenied > PcpErrorArcPermissionDeniedPtr
Definition: errors.h:149
static PcpErrorMutedAssetPathPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorInternalAssetPath > PcpErrorInternalAssetPathPtr
Definition: errors.h:321
SdfLayerHandle layer
Definition: errors.h:591
virtual PCP_API std::string ToString() const
Converts error to string message.
virtual PCP_API std::string ToString() const
Converts error to string message.
PcpSiteStr privateSite
The private, invalid target of the arc.
Definition: errors.h:769
PCP_API ~PcpErrorInvalidSublayerOwnership()
Destructor.
static PcpErrorInvalidReferenceOffsetPtr New()
Returns a new error object.
virtual PCP_API std::string ToString() const
Converts error to string message.
static PcpErrorInternalAssetPathPtr New()
Returns a new error object.
static PcpErrorSublayerCyclePtr New()
Returns a new error object.
SdfLayerHandle layer
Definition: errors.h:680
TfToken definingValueType
The value type from the defining spec.
Definition: errors.h:278
static PcpErrorInvalidPrimPathPtr New()
Returns a new error object.
virtual PCP_API std::string ToString() const
Converts error to string message.
static PcpErrorInvalidTargetPathPtr New()
Returns a new error object.
Definition: token.h:87
PcpErrorBase(TfEnum errorType)
Constructor.
PcpErrorInvalidAssetPathBase(TfEnum errorType)
Constructor.
SdfLayerHandle sublayer
Definition: errors.h:825
virtual PCP_API ~PcpErrorInconsistentPropertyBase()
Destructor.
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorInvalidSublayerOffset > PcpErrorInvalidSublayerOffsetPtr
Definition: errors.h:574
virtual PCP_API std::string ToString() const
Converts error to string message.
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorUnresolvedPrimPath > PcpErrorUnresolvedPrimPathPtr
Definition: errors.h:860
static PcpErrorCapacityExceededPtr New(PcpErrorType errorType)
Returns a new error object.
std::shared_ptr< PcpErrorTargetPathBase > PcpErrorTargetPathBasePtr
Definition: errors.h:459
virtual PCP_API std::string ToString() const
Converts error to string message.
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorInconsistentPropertyType > PcpErrorInconsistentPropertyTypePtr
Definition: errors.h:228
PCP_API ~PcpErrorInvalidPrimPath()
Destructor.
SdfVariability definingVariability
The variability of the defining spec.
Definition: errors.h:309
std::shared_ptr< PcpErrorInvalidSublayerPath > PcpErrorInvalidSublayerPathPtr
Definition: errors.h:663
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
SdfLayerHandle sublayer
Definition: errors.h:592
SdfLayerOffset offset
Definition: errors.h:593
static PcpErrorInconsistentPropertyTypePtr New()
Returns a new error object.
SdfPath conflictingSpecPath
The path of the conflicting property spec.
Definition: errors.h:218
std::string assetPath
Definition: errors.h:341
static PcpErrorPrimPermissionDeniedPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorInvalidReferenceOffset > PcpErrorInvalidReferenceOffsetPtr
Definition: errors.h:603
SdfSpecType conflictingSpecType
The type of the conflicting spec.
Definition: errors.h:249
const TfEnum errorType
The error code.
Definition: errors.h:96
std::shared_ptr< PcpErrorInvalidTargetPath > PcpErrorInvalidTargetPathPtr
Definition: errors.h:549
static PcpErrorInvalidAssetPathPtr New()
Returns a new error object.
std::string definingLayerIdentifier
The identifier of the layer with the defining property spec.
Definition: errors.h:211
std::vector< PcpErrorBasePtr > PcpErrorVector
Definition: errors.h:82
Definition: path.h:288
PcpSiteStr site
The site where the invalid arc was expressed.
Definition: errors.h:767
std::shared_ptr< PcpErrorCapacityExceeded > PcpErrorCapacityExceededPtr
Definition: errors.h:182
static PcpErrorInvalidInstanceTargetPathPtr New()
Returns a new error object.
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorSublayerCycle()
Destructor.
static PcpErrorArcCyclePtr New()
Returns a new error object.
PCP_API ~PcpErrorOpinionAtRelocationSource()
Destructor.
virtual PCP_API std::string ToString() const
Converts error to string message.
SdfVariability
Definition: types.h:179
PCP_API ~PcpErrorInvalidTargetPath()
Destructor.
SdfLayerHandle layer
Definition: errors.h:824
virtual PCP_API std::string ToString() const
Converts error to string message.
static PcpErrorInvalidExternalTargetPathPtr New()
Returns a new error object.
virtual PCP_API std::string ToString() const
Converts error to string message.
PcpArcType arcType
Definition: errors.h:373
PCP_API ~PcpErrorTargetPathBase()
Destructor.
virtual PCP_API std::string ToString() const
Converts error to string message.
TfToken conflictingValueType
The value type from the conflicting spec.
Definition: errors.h:280
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
SdfSpecType
Definition: types.h:91
PCP_API ~PcpErrorInconsistentAttributeVariability()
Destructor.
std::string sublayerPath
Definition: errors.h:681
PCP_API ~PcpErrorCapacityExceeded()
Destructor.
std::shared_ptr< PcpErrorInvalidAssetPath > PcpErrorInvalidAssetPathPtr
Definition: errors.h:409
PcpSiteStr site
The site where the invalid arc was expressed.
Definition: errors.h:878
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorMutedAssetPath > PcpErrorMutedAssetPathPtr
Definition: errors.h:434
std::shared_ptr< PcpErrorSublayerCycle > PcpErrorSublayerCyclePtr
Definition: errors.h:808
std::vector< PcpSiteTrackerSegment > PcpSiteTracker
Definition: types.h:130
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorTargetPermissionDenied()
Destructor.
SdfLayerHandle layer
Definition: errors.h:398
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:170
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static PcpErrorInvalidSublayerOffsetPtr New()
Returns a new error object.
SdfSpecType ownerSpecType
The spec type of the property where the target was authored.
Definition: errors.h:477
static PcpErrorPropertyPermissionDeniedPtr New()
Returns a new error object.
PCP_API ~PcpErrorArcCycle()
Destructor.
std::shared_ptr< PcpErrorInvalidAssetPathBase > PcpErrorInvalidAssetPathBasePtr
Definition: errors.h:383
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:168
std::shared_ptr< PcpErrorInconsistentAttributeType > PcpErrorInconsistentAttributeTypePtr
Definition: errors.h:259
PcpSiteStr rootSite
Definition: errors.h:102
PcpErrorTargetPathBase(TfEnum errorType)
std::string resolvedAssetPath
Definition: errors.h:396
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:393
static PcpErrorUnresolvedPrimPathPtr New()
Returns a new error object.
static PcpErrorArcPermissionDeniedPtr New()
Returns a new error object.
PCP_API ~PcpErrorInvalidReferenceOffset()
Destructor.
PCP_API ~PcpErrorInconsistentPropertyType()
Destructor.
static PcpErrorInvalidSublayerPathPtr New()
Returns a new error object.
PcpArcType arcType
The type of arc.
Definition: errors.h:172
std::shared_ptr< PcpErrorInvalidPrimPath > PcpErrorInvalidPrimPathPtr
Definition: errors.h:353
std::shared_ptr< PcpErrorTargetPermissionDenied > PcpErrorTargetPermissionDeniedPtr
Definition: errors.h:835
std::shared_ptr< PcpErrorInvalidSublayerOwnership > PcpErrorInvalidSublayerOwnershipPtr
Definition: errors.h:634
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:339
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorPrimPermissionDenied()
Destructor.
static PcpErrorOpinionAtRelocationSourcePtr New()
Returns a new error object.
PcpSiteTracker cycle
Definition: errors.h:139
virtual PCP_API std::string ToString() const
Converts error to string message.
virtual PCP_API std::string ToString() const
Converts error to string message.
PcpErrorInconsistentPropertyBase(TfEnum errorType)
Constructor.
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorPropertyPermissionDenied > PcpErrorPropertyPermissionDeniedPtr
Definition: errors.h:779
SdfLayerHandle layer
The layer containing the property where the target was authored.
Definition: errors.h:479
std::shared_ptr< PcpErrorInvalidExternalTargetPath > PcpErrorInvalidExternalTargetPathPtr
Definition: errors.h:520
PcpErrorType
Definition: errors.h:50
#define PCP_API
Definition: api.h:40
PCP_API ~PcpErrorInternalAssetPath()
Destructor.
PcpArcType
Definition: types.h:46
PCP_API ~PcpErrorInconsistentAttributeType()
Destructor.