UsdValidationError is an entity returned by a validation task, which is associated with a UsdValidationValidator.
A UsdValidationError instance contains important information, like:
- Name - A name the validator writer provided for the error. This is then used to construct an identifier for the error.
- UsdValidationErrorType - severity of an error,
- UsdValidationErrorSites - on what sites validationError was reported by a validation task,
- Message - Message providing more information associated with the error. Such a message is provided by the validator writer, when providing implementation for the validation task function.
UsdValidationError instances will be stored in the UsdValidationContext responsible for executing a set of UsdValidationValidators.
Definition at line 224 of file error.h.
An identifier for the error constructed from the validator name this error was generated from and its name.
Since a validator may result in multiple distinct errors, the identifier helps in distinguishing and categorizing the errors. The identifier returned will be in the following form: For a plugin validator: "plugName":"validatorName"."ErrorName" For a non-plugin validator: "validatorName"."ErrorName"
For an error that was generated without a name, the identifier will be same as the validator name which generated the error.
For an error which is created directly and not via UsdValidationValidator::Validate() call, we throw a coding error, as its an improper use of the API.