HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
UsdValidationValidatorMetadata Class Reference

#include <validator.h>

Public Attributes

TfToken name
 
PlugPluginPtr pluginPtr
 
TfTokenVector keywords
 list of keywords extracted for this test from the plugInfo.json More...
 
std::string doc
 
TfTokenVector schemaTypes
 
bool isTimeDependent
 
bool isSuite
 whether this test represents a test suite or not More...
 

Detailed Description

A structure which describes metadata for a UsdValidationValidator.

The metadata values are populated from the plugInfo.json associated with a validator's plugin. PlugInfo can provide the following validator metadata:

  • name: A required field. This metadatum stores the validator name. For validators defined in a plugin, the name must be a fully qualified name which includes the pluginName as well, separated by ":". This ensures, plugin provided validator names are guaranteed to be unique.
  • pluginPtr: Pointer to the plugin where a plugin based validator is defined. nullptr for a non-plugin based validator.
  • keywords: Keywords associated with this validator.
  • doc: Doc string explaining the purpose of the validator.
  • schemaTypes: If the validator is associated with specific schemaTypes.
  • isTimeDependent: If the validator is testing rules which are time dependent. Note that only PrimValidators and StageValidators can be time dependent, as these are the ones which can evaluate time dependent properties. Note that its still recommended to use PrimValidators for time dependent properties. Default is false.
  • isSuite: If the validator represents a suite of validators.

Definition at line 54 of file validator.h.

Member Data Documentation

std::string UsdValidationValidatorMetadata::doc

doc string extracted from plugInfo.json This is a mandatory field for a ValidatorMetadata.

Definition at line 75 of file validator.h.

bool UsdValidationValidatorMetadata::isSuite

whether this test represents a test suite or not

Definition at line 87 of file validator.h.

bool UsdValidationValidatorMetadata::isTimeDependent

whether this test is time dependent or not. Only PrimValidators and StageValidators can be time dependent. By default this is false.

Definition at line 84 of file validator.h.

TfTokenVector UsdValidationValidatorMetadata::keywords

list of keywords extracted for this test from the plugInfo.json

Definition at line 71 of file validator.h.

TfToken UsdValidationValidatorMetadata::name

Name of the validator.

For plugin provided validators, this is prefixed with the pluginName, like "pluginName:testName" in order to uniquely identify these plugin provided validators.

This is a mandatory field for a ValidatorMetadata.

Definition at line 63 of file validator.h.

PlugPluginPtr UsdValidationValidatorMetadata::pluginPtr

Pointer to the plugin to which a plugin based validator belongs.

For non-plugin based validator, pluginPtr is nullptr.

Definition at line 68 of file validator.h.

TfTokenVector UsdValidationValidatorMetadata::schemaTypes

list of schemaTypes names this test applies to, extracted from plugInfo.json

Definition at line 79 of file validator.h.

The documentation for this class was generated from the following file: