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 ///
74 };
75 
76 // Forward declarations:
78 typedef std::shared_ptr<PcpErrorBase> PcpErrorBasePtr;
79 typedef std::vector<PcpErrorBasePtr> PcpErrorVector;
80 
81 /// \class PcpErrorBase
82 ///
83 /// Base class for all error types.
84 ///
85 class PcpErrorBase {
86 public:
87  /// Destructor.
88  PCP_API virtual ~PcpErrorBase();
89  /// Converts error to string message.
90  virtual std::string ToString() const = 0;
91 
92  /// The error code.
94 
95  /// The site of the composed prim or property being computed when
96  /// the error was encountered. (Note that some error types
97  /// contain an additional site to capture more specific information
98  /// about the site of the error.)
100 
101 protected:
102  /// Constructor.
104 };
105 
106 ///////////////////////////////////////////////////////////////////////////////
107 
108 // Forward declarations:
110 typedef std::shared_ptr<PcpErrorArcCycle> PcpErrorArcCyclePtr;
111 
112 /// \class PcpErrorArcCycle
113 ///
114 /// Arcs between PcpNodes that form a cycle.
115 ///
117 public:
118  /// Returns a new error object.
119  static PcpErrorArcCyclePtr New();
120  /// Destructor.
122  /// Converts error to string message.
123  PCP_API virtual std::string ToString() const;
124 
126 
127 private:
128  /// Constructor is private. Use New() instead.
130 };
131 
132 ///////////////////////////////////////////////////////////////////////////////
133 
134 // Forward declarations:
136 typedef std::shared_ptr<PcpErrorArcPermissionDenied>
138 
139 /// \class PcpErrorArcPermissionDenied
140 ///
141 /// Arcs that were not made between PcpNodes because of permission
142 /// restrictions.
143 ///
145 public:
146  /// Returns a new error object.
148  /// Destructor.
150  /// Converts error to string message.
151  PCP_API virtual std::string ToString() const;
152 
153  /// The site where the invalid arc was expressed.
155  /// The private, invalid target of the arc.
157  /// The type of arc.
159 
160 private:
161  /// Constructor is private. Use New() instead.
163 };
164 
165 ///////////////////////////////////////////////////////////////////////////////
166 
168 public:
169  /// Destructor.
171 
172  /// The identifier of the layer with the defining property spec.
174  /// The path of the defining property spec.
176 
177  /// The identifier of the layer with the conflicting property spec.
179  /// The path of the conflicting property spec.
181 
182 protected:
183  /// Constructor.
185 };
186 
187 ///////////////////////////////////////////////////////////////////////////////
188 
189 // Forward declarations:
191 typedef std::shared_ptr<PcpErrorInconsistentPropertyType>
193 
194 /// \class PcpErrorInconsistentPropertyType
195 ///
196 /// Properties that have specs with conflicting definitions.
197 ///
200 public:
201  /// Returns a new error object.
203  /// Destructor.
205  /// Converts error to string message.
206  PCP_API virtual std::string ToString() const;
207 
208  /// The type of the defining spec.
210  /// The type of the conflicting spec.
212 
213 private:
214  /// Constructor is private. Use New() instead.
216 };
217 
218 ///////////////////////////////////////////////////////////////////////////////
219 
220 // Forward declarations:
222 typedef std::shared_ptr<PcpErrorInconsistentAttributeType>
224 
225 /// \class PcpErrorInconsistentAttributeType
226 ///
227 /// Attributes that have specs with conflicting definitions.
228 ///
231 public:
232  /// Returns a new error object.
234  /// Destructor.
236  /// Converts error to string message.
237  PCP_API virtual std::string ToString() const;
238 
239  /// The value type from the defining spec.
241  /// The value type from the conflicting spec.
243 
244 private:
245  /// Constructor is private. Use New() instead.
247 };
248 
249 ///////////////////////////////////////////////////////////////////////////////
250 
251 // Forward declarations:
253 typedef std::shared_ptr<PcpErrorInconsistentAttributeVariability>
255 
256 /// \class PcpErrorInconsistentAttributeVariability
257 ///
258 /// Attributes that have specs with conflicting variability.
259 ///
262 public:
263  /// Returns a new error object.
265  /// Destructor.
267  /// Converts error to string message.
268  PCP_API virtual std::string ToString() const;
269 
270  /// The variability of the defining spec.
272  /// The variability of the conflicting spec.
274 
275 private:
276  /// Constructor is private. Use New() instead.
278 };
279 
280 ///////////////////////////////////////////////////////////////////////////////
281 
282 // Forward declarations:
284 typedef std::shared_ptr<PcpErrorInternalAssetPath>
286 
287 /// \class PcpErrorInternalAssetPath
288 ///
289 /// Error about an arc that is prohibited due to being internal to an asset.
290 ///
292 public:
293  /// Returns a new error object.
295  /// Destructor.
297  /// Converts error to string message.
298  PCP_API virtual std::string ToString() const;
299 
300  /// The site where the invalid arc was expressed.
306 
307 private:
308  /// Constructor is private. Use New() instead.
310 };
311 
312 ///////////////////////////////////////////////////////////////////////////////
313 
314 // Forward declarations:
316 typedef std::shared_ptr<PcpErrorInvalidPrimPath>
318 
319 /// \class PcpErrorInvalidPrimPath
320 ///
321 /// Invalid prim paths used by references or payloads.
322 ///
324 public:
325  /// Returns a new error object.
327  /// Destructor.
329  /// Converts error to string message.
330  PCP_API virtual std::string ToString() const;
331 
332  /// The site where the invalid arc was expressed.
336 
337 private:
338  /// Constructor is private. Use New() instead.
340 };
341 
342 ///////////////////////////////////////////////////////////////////////////////
343 
344 // Forward declarations:
346 typedef std::shared_ptr<PcpErrorInvalidAssetPathBase>
348 
350 public:
351  /// Destructor.
353 
354  /// The site where the invalid arc was expressed.
360  SdfLayerHandle layer;
362 
363 protected:
364  /// Constructor.
366 };
367 
368 ///////////////////////////////////////////////////////////////////////////////
369 
370 // Forward declarations:
372 typedef std::shared_ptr<PcpErrorInvalidAssetPath>
374 
375 /// \class PcpErrorInvalidAssetPath
376 ///
377 /// Invalid asset paths used by references or payloads.
378 ///
380 public:
381  /// Returns a new error object.
383  /// Destructor.
385  /// Converts error to string message.
386  PCP_API virtual std::string ToString() const;
387 
388 private:
389  /// Constructor is private. Use New() instead.
391 };
392 
393 ///////////////////////////////////////////////////////////////////////////////
394 
395 // Forward declarations:
397 typedef std::shared_ptr<PcpErrorMutedAssetPath>
399 
400 /// \class PcpErrorMutedAssetPath
401 ///
402 /// Muted asset paths used by references or payloads.
403 ///
405 public:
406  /// Returns a new error object.
408  /// Destructor.
410  /// Converts error to string message.
411  PCP_API virtual std::string ToString() const;
412 
413 private:
414  /// Constructor is private. Use New() instead.
416 };
417 
418 ///////////////////////////////////////////////////////////////////////////////
419 
420 // Forward declarations:
422 typedef std::shared_ptr<PcpErrorTargetPathBase>
424 
425 /// \class PcpErrorTargetPathBase
426 ///
427 /// Base class for composition errors related to target or connection paths.
428 ///
430 public:
431  /// Destructor.
433 
434  /// The invalid target or connection path that was authored.
436  /// The path to the property where the target was authored.
438  /// The spec type of the property where the target was authored.
440  /// The layer containing the property where the target was authored.
441  SdfLayerHandle layer;
442 
443  /// The target or connection path in the composed scene.
444  /// If this path could not be translated to the composed scene
445  /// (e.g., in the case of an invalid external target path),
446  /// this path will be empty.
448 
449 protected:
451 };
452 
453 ///////////////////////////////////////////////////////////////////////////////
454 
455 // Forward declarations:
457 typedef std::shared_ptr<PcpErrorInvalidInstanceTargetPath>
459 
460 /// \class PcpErrorInvalidInstanceTargetPath
461 ///
462 /// Invalid target or connection path authored in an inherited
463 /// class that points to an instance of that class.
464 ///
466 public:
467  /// Returns a new error object.
469  /// Destructor.
471  /// Converts error to string message.
472  PCP_API virtual std::string ToString() const;
473 
474 private:
475  /// Constructor is private. Use New() instead.
477 };
478 
479 ///////////////////////////////////////////////////////////////////////////////
480 
481 // Forward declarations:
483 typedef std::shared_ptr<PcpErrorInvalidExternalTargetPath>
485 
486 /// \class PcpErrorInvalidExternalTargetPath
487 ///
488 /// Invalid target or connection path in some scope that points to
489 /// an object outside of that scope.
490 ///
492 public:
493  /// Returns a new error object.
495  /// Destructor.
497  /// Converts error to string message.
498  PCP_API virtual std::string ToString() const;
499 
502 
503 private:
504  /// Constructor is private. Use New() instead.
506 };
507 
508 ///////////////////////////////////////////////////////////////////////////////
509 
510 // Forward declarations:
512 typedef std::shared_ptr<PcpErrorInvalidTargetPath>
514 
515 /// \class PcpErrorInvalidTargetPath
516 ///
517 /// Invalid target or connection path.
518 ///
520 public:
521  /// Returns a new error object.
523  /// Destructor.
525  /// Converts error to string message.
526  PCP_API virtual std::string ToString() const;
527 
528 private:
529  /// Constructor is private. Use New() instead.
531 };
532 
533 ///////////////////////////////////////////////////////////////////////////////
534 
535 // Forward declarations:
537 typedef std::shared_ptr<PcpErrorInvalidSublayerOffset>
539 
540 /// \class PcpErrorInvalidSublayerOffset
541 ///
542 /// Sublayers that use invalid layer offsets.
543 ///
545 public:
546  /// Returns a new error object.
548  /// Destructor.
550  /// Converts error to string message.
551  PCP_API virtual std::string ToString() const;
552 
553  SdfLayerHandle layer;
554  SdfLayerHandle sublayer;
556 
557 private:
558  /// Constructor is private. Use New() instead.
560 };
561 
562 ///////////////////////////////////////////////////////////////////////////////
563 
564 // Forward declarations:
566 typedef std::shared_ptr<PcpErrorInvalidReferenceOffset>
568 
569 /// \class PcpErrorInvalidReferenceOffset
570 ///
571 /// Sublayers that use invalid layer offsets.
572 ///
574 public:
575  /// Returns a new error object.
577  /// Destructor.
579  /// Converts error to string message.
580  PCP_API virtual std::string ToString() const;
581 
582  SdfLayerHandle layer;
587 
588 private:
589  /// Constructor is private. Use New() instead.
591 };
592 
593 ///////////////////////////////////////////////////////////////////////////////
594 
595 // Forward declarations:
597 typedef std::shared_ptr<PcpErrorInvalidSublayerOwnership>
599 
600 /// \class PcpErrorInvalidSublayerOwnership
601 ///
602 /// Sibling layers that have the same owner.
603 ///
605 public:
606  /// Returns a new error object.
608  /// Destructor.
610  /// Converts error to string message.
611  PCP_API virtual std::string ToString() const;
612 
614  SdfLayerHandle layer;
615  SdfLayerHandleVector sublayers;
616 
617 private:
618  /// Constructor is private. Use New() instead.
620 };
621 
622 ///////////////////////////////////////////////////////////////////////////////
623 
624 // Forward declarations:
626 typedef std::shared_ptr<PcpErrorInvalidSublayerPath>
628 
629 /// \class PcpErrorInvalidSublayerPath
630 ///
631 /// Asset paths that could not be both resolved and loaded.
632 ///
634 public:
635  /// Returns a new error object.
637  /// Destructor.
639  /// Converts error to string message.
640  PCP_API virtual std::string ToString() const;
641 
642  SdfLayerHandle layer;
645 
646 private:
647  /// Constructor is private. Use New() instead.
649 };
650 
651 ///////////////////////////////////////////////////////////////////////////////
652 
653 // Forward declarations:
655 typedef std::shared_ptr<PcpErrorInvalidVariantSelection>
657 
658 /// \class PcpErrorInvalidVariantSelection
659 ///
660 /// Invalid variant selections.
661 ///
663 public:
664  /// Returns a new error object.
666  /// Destructor.
668  /// Converts error to string message.
669  PCP_API virtual std::string ToString() const;
670 
674 
675 private:
676  /// Constructor is private. Use New() instead.
678 };
679 
680 ///////////////////////////////////////////////////////////////////////////////
681 
682 // Forward declarations:
684 typedef std::shared_ptr<PcpErrorOpinionAtRelocationSource>
686 
687 /// \class PcpErrorOpinionAtRelocationSource
688 ///
689 /// Opinions were found at a relocation source path.
690 ///
692 public:
693  /// Returns a new error object.
695  /// Destructor.
697  /// Converts error to string message.
698  PCP_API virtual std::string ToString() const;
699 
700  SdfLayerHandle layer;
702 
703 private:
704  /// Constructor is private. Use New() instead.
706 };
707 
708 ///////////////////////////////////////////////////////////////////////////////
709 
710 // Forward declarations:
712 typedef std::shared_ptr<PcpErrorPrimPermissionDenied>
714 
715 /// \class PcpErrorPrimPermissionDenied
716 ///
717 /// Layers with illegal opinions about private prims.
718 ///
720 public:
721  /// Returns a new error object.
723  /// Destructor.
725  /// Converts error to string message.
726  PCP_API virtual std::string ToString() const;
727 
728  /// The site where the invalid arc was expressed.
730  /// The private, invalid target of the arc.
732 
733 private:
734  /// Constructor is private. Use New() instead.
736 };
737 
738 ///////////////////////////////////////////////////////////////////////////////
739 
740 // Forward declarations:
742 typedef std::shared_ptr<PcpErrorPropertyPermissionDenied>
744 
745 /// \class PcpErrorPropertyPermissionDenied
746 ///
747 /// Layers with illegal opinions about private properties.
748 ///
750 public:
751  /// Returns a new error object.
753  /// Destructor.
755  /// Converts error to string message.
756  PCP_API virtual std::string ToString() const;
757 
761 
762 private:
763  /// Constructor is private. Use New() instead.
765 };
766 
767 ///////////////////////////////////////////////////////////////////////////////
768 
769 // Forward declarations:
771 typedef std::shared_ptr<PcpErrorSublayerCycle> PcpErrorSublayerCyclePtr;
772 
773 /// \class PcpErrorSublayerCycle
774 ///
775 /// Layers that recursively sublayer themselves.
776 ///
778 public:
779  /// Returns a new error object.
780  static PcpErrorSublayerCyclePtr New();
781  /// Destructor.
783  /// Converts error to string message.
784  PCP_API virtual std::string ToString() const;
785 
786  SdfLayerHandle layer;
787  SdfLayerHandle sublayer;
788 
789 private:
790  /// Constructor is private. Use New() instead.
792 };
793 
794 ///////////////////////////////////////////////////////////////////////////////
795 
796 // Forward declarations:
798 typedef std::shared_ptr<PcpErrorTargetPermissionDenied>
800 
801 /// \class PcpErrorTargetPermissionDenied
802 ///
803 /// Paths with illegal opinions about private targets.
804 ///
806 public:
807  /// Returns a new error object.
809  /// Destructor.
811  /// Converts error to string message.
812  PCP_API virtual std::string ToString() const;
813 
814 private:
815  /// Constructor is private. Use New() instead.
817 };
818 
819 ///////////////////////////////////////////////////////////////////////////////
820 
821 // Forward declarations:
823 typedef std::shared_ptr<PcpErrorUnresolvedPrimPath>
825 
826 /// \class PcpErrorUnresolvedPrimPath
827 ///
828 /// Asset paths that could not be both resolved and loaded.
829 ///
831 public:
832  /// Returns a new error object.
834  /// Destructor.
836  /// Converts error to string message.
837  PCP_API virtual std::string ToString() const;
838 
839  /// The site where the invalid arc was expressed.
843 
844 private:
845  /// Constructor is private. Use New() instead.
847 };
848 
849 /// Raise the given errors as runtime errors.
850 PCP_API
851 void PcpRaiseErrors(const PcpErrorVector &errors);
852 
854 
855 #endif // PXR_USD_PCP_ERRORS_H
std::shared_ptr< PcpErrorBase > PcpErrorBasePtr
Definition: errors.h:77
PCP_API ~PcpErrorMutedAssetPath()
Destructor.
std::shared_ptr< PcpErrorInvalidVariantSelection > PcpErrorInvalidVariantSelectionPtr
Definition: errors.h:654
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorInvalidExternalTargetPath()
Destructor.
SdfPath composedTargetPath
Definition: errors.h:447
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:333
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:178
std::shared_ptr< PcpErrorPrimPermissionDenied > PcpErrorPrimPermissionDeniedPtr
Definition: errors.h:711
PCP_API ~PcpErrorInvalidInstanceTargetPath()
Destructor.
static PcpErrorInconsistentAttributeTypePtr New()
Returns a new error object.
PCP_API ~PcpErrorInvalidSublayerOffset()
Destructor.
std::shared_ptr< PcpErrorArcCycle > PcpErrorArcCyclePtr
Definition: errors.h:109
static PcpErrorTargetPermissionDeniedPtr New()
Returns a new error object.
SdfPath owningPath
The path to the property where the target was authored.
Definition: errors.h:437
PCP_API ~PcpErrorUnresolvedPrimPath()
Destructor.
PCP_API ~PcpErrorInvalidSublayerPath()
Destructor.
static PcpErrorInvalidSublayerOwnershipPtr New()
Returns a new error object.
SdfPath targetPath
The invalid target or connection path that was authored.
Definition: errors.h:435
PCP_API ~PcpErrorInvalidAssetPath()
Destructor.
SdfVariability conflictingVariability
The variability of the conflicting spec.
Definition: errors.h:273
static PcpErrorInconsistentAttributeVariabilityPtr New()
Returns a new error object.
static PcpErrorInvalidVariantSelectionPtr New()
Returns a new error object.
SdfLayerHandleVector sublayers
Definition: errors.h:615
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorInconsistentAttributeVariability > PcpErrorInconsistentAttributeVariabilityPtr
Definition: errors.h:252
PCP_API ~PcpErrorArcPermissionDenied()
Destructor.
virtual PCP_API std::string ToString() const
Converts error to string message.
PCP_API ~PcpErrorInvalidVariantSelection()
Destructor.
Definition: cache.h:91
std::shared_ptr< PcpErrorOpinionAtRelocationSource > PcpErrorOpinionAtRelocationSourcePtr
Definition: errors.h:683
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:304
std::shared_ptr< PcpErrorInvalidInstanceTargetPath > PcpErrorInvalidInstanceTargetPathPtr
Definition: errors.h:456
SdfSpecType definingSpecType
The type of the defining spec.
Definition: errors.h:209
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:175
std::shared_ptr< PcpErrorArcPermissionDenied > PcpErrorArcPermissionDeniedPtr
Definition: errors.h:135
static PcpErrorMutedAssetPathPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorInternalAssetPath > PcpErrorInternalAssetPathPtr
Definition: errors.h:283
SdfLayerHandle layer
Definition: errors.h:553
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:731
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:642
TfToken definingValueType
The value type from the defining spec.
Definition: errors.h:240
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:787
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:536
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:822
std::shared_ptr< PcpErrorTargetPathBase > PcpErrorTargetPathBasePtr
Definition: errors.h:421
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:190
PCP_API ~PcpErrorInvalidPrimPath()
Destructor.
SdfVariability definingVariability
The variability of the defining spec.
Definition: errors.h:271
std::shared_ptr< PcpErrorInvalidSublayerPath > PcpErrorInvalidSublayerPathPtr
Definition: errors.h:625
SdfLayerHandle sublayer
Definition: errors.h:554
SdfLayerOffset offset
Definition: errors.h:555
static PcpErrorInconsistentPropertyTypePtr New()
Returns a new error object.
SdfPath conflictingSpecPath
The path of the conflicting property spec.
Definition: errors.h:180
std::string assetPath
Definition: errors.h:303
static PcpErrorPrimPermissionDeniedPtr New()
Returns a new error object.
std::shared_ptr< PcpErrorInvalidReferenceOffset > PcpErrorInvalidReferenceOffsetPtr
Definition: errors.h:565
SdfSpecType conflictingSpecType
The type of the conflicting spec.
Definition: errors.h:211
const TfEnum errorType
The error code.
Definition: errors.h:93
std::shared_ptr< PcpErrorInvalidTargetPath > PcpErrorInvalidTargetPathPtr
Definition: errors.h:511
static PcpErrorInvalidAssetPathPtr New()
Returns a new error object.
std::string definingLayerIdentifier
The identifier of the layer with the defining property spec.
Definition: errors.h:173
std::vector< PcpErrorBasePtr > PcpErrorVector
Definition: errors.h:79
Definition: path.h:288
PcpSiteStr site
The site where the invalid arc was expressed.
Definition: errors.h:729
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:786
GLsizei const GLchar *const * string
Definition: glew.h:1844
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:335
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:242
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
SdfSpecType
Definition: types.h:91
PCP_API ~PcpErrorInconsistentAttributeVariability()
Destructor.
std::string sublayerPath
Definition: errors.h:643
std::shared_ptr< PcpErrorInvalidAssetPath > PcpErrorInvalidAssetPathPtr
Definition: errors.h:371
PcpSiteStr site
The site where the invalid arc was expressed.
Definition: errors.h:840
virtual PCP_API std::string ToString() const
Converts error to string message.
std::shared_ptr< PcpErrorMutedAssetPath > PcpErrorMutedAssetPathPtr
Definition: errors.h:396
std::shared_ptr< PcpErrorSublayerCycle > PcpErrorSublayerCyclePtr
Definition: errors.h:770
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:360
PcpSite privateSite
The private, invalid target of the arc.
Definition: errors.h:156
#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:439
static PcpErrorPropertyPermissionDeniedPtr New()
Returns a new error object.
PCP_API ~PcpErrorArcCycle()
Destructor.
std::shared_ptr< PcpErrorInvalidAssetPathBase > PcpErrorInvalidAssetPathBasePtr
Definition: errors.h:345
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:154
std::shared_ptr< PcpErrorInconsistentAttributeType > PcpErrorInconsistentAttributeTypePtr
Definition: errors.h:221
PcpSiteStr rootSite
Definition: errors.h:99
PcpErrorTargetPathBase(TfEnum errorType)
std::string resolvedAssetPath
Definition: errors.h:358
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:355
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:158
std::shared_ptr< PcpErrorInvalidPrimPath > PcpErrorInvalidPrimPathPtr
Definition: errors.h:315
std::shared_ptr< PcpErrorTargetPermissionDenied > PcpErrorTargetPermissionDeniedPtr
Definition: errors.h:797
std::shared_ptr< PcpErrorInvalidSublayerOwnership > PcpErrorInvalidSublayerOwnershipPtr
Definition: errors.h:596
PcpSite site
The site where the invalid arc was expressed.
Definition: errors.h:301
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:125
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:741
SdfLayerHandle layer
The layer containing the property where the target was authored.
Definition: errors.h:441
std::shared_ptr< PcpErrorInvalidExternalTargetPath > PcpErrorInvalidExternalTargetPathPtr
Definition: errors.h:482
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.