UsdValidator is a class describing a single test. More...

#include <validator.h>

Public Member Functions
USD_API	UsdValidator (const UsdValidatorMetadata &metadata)
	Instantiate a UsdValidator which has no validation logic implementation.

	UsdValidator (const UsdValidator &other)=delete

UsdValidator &	operator= (const UsdValidator &)=delete

	UsdValidator (UsdValidator &&other) noexcept=default

UsdValidator &	operator= (UsdValidator &&) noexcept=default

USD_API	UsdValidator (const UsdValidatorMetadata &metadata, const UsdValidateLayerTaskFn &validateLayerTaskFn)
	Instantiate a UsdValidator which has its validation logic implemented by a UsdValidateLayerTaskFn.

USD_API	UsdValidator (const UsdValidatorMetadata &metadata, const UsdValidateStageTaskFn &validateStageTaskFn)
	Instantiate a UsdValidator which has its validation logic implemented by a UsdValidateStageTaskFn.

USD_API	UsdValidator (const UsdValidatorMetadata &metadata, const UsdValidatePrimTaskFn &validatePrimTaskFn)
	Instantiate a UsdValidator which has its validation logic implemented by a UsdValidatePrimTaskFn.

const UsdValidatorMetadata &	GetMetadata () const &
	Return metadata associated with this Validator.

UsdValidatorMetadata	GetMetadata () &&
	Return metadata associated with this validator by-value.

USD_API UsdValidationErrorVector	Validate (const SdfLayerHandle &layer) const
	Run validation on the given `layer` by executing the contained validateTaskFn and returns UsdValidationErrorVector.

USD_API UsdValidationErrorVector	Validate (const UsdStagePtr &usdStage) const
	Run validation on the given `usdStage` by executing the contained validateTaskFn and returns UsdValidationErrorVector.

USD_API UsdValidationErrorVector	Validate (const UsdPrim &usdPrim) const
	Run validation on the given `usdPrim` by executing the contained validateTaskFn and returns UsdValidationErrorVector.

Friends
class	UsdValidationRegistry

class	UsdValidationContext

Detailed Description

UsdValidator is a class describing a single test.

An instance of UsdValidator is created when plugins are loaded and tests are registered and cached in the UsdValidationRegistry. UsdValidator can consist of any one of the 3 testing tasks: LayerTestingTask, StageTestingTask or PrimTestingTask, which correspond to testing the given SdfLayer, an entire UsdStage or a UsdPrim respectively.

UsdValidator instances are immutable and non-copyable. Note that all validators which are registered with the UsdValidationRegistry are immortal.

See also: UsdValidationRegistry

Definition at line 119 of file validator.h.

Constructor & Destructor Documentation

◆ UsdValidator() [1/4]

USD_API UsdValidator ( const UsdValidatorMetadata & metadata )

explicit

Instantiate a UsdValidator which has no validation logic implementation.

This is primarily used by UsdValidatorSuite.

◆ UsdValidator() [2/4]

USD_API UsdValidator	(	const UsdValidatorMetadata &	metadata,
		const UsdValidateLayerTaskFn &	validateLayerTaskFn
	)

Instantiate a UsdValidator which has its validation logic implemented by a UsdValidateLayerTaskFn.

◆ UsdValidator() [3/4]

USD_API UsdValidator	(	const UsdValidatorMetadata &	metadata,
		const UsdValidateStageTaskFn &	validateStageTaskFn
	)

Instantiate a UsdValidator which has its validation logic implemented by a UsdValidateStageTaskFn.

◆ UsdValidator() [4/4]

USD_API UsdValidator	(	const UsdValidatorMetadata &	metadata,
		const UsdValidatePrimTaskFn &	validatePrimTaskFn
	)

Instantiate a UsdValidator which has its validation logic implemented by a UsdValidatePrimTaskFn.

Member Function Documentation

◆ GetMetadata() [1/2]

UsdValidatorMetadata GetMetadata ( ) &&

inline

Return metadata associated with this validator by-value.

Definition at line 158 of file validator.h.

◆ GetMetadata() [2/2]

const UsdValidatorMetadata & GetMetadata ( ) const &

inline

Return metadata associated with this Validator.

Definition at line 152 of file validator.h.

◆ Validate() [1/3]

USD_API UsdValidationErrorVector Validate ( const SdfLayerHandle & layer ) const

Run validation on the given layer by executing the contained validateTaskFn and returns UsdValidationErrorVector.

If this Validator doesn't provide a UsdValidateLayerTaskFn, then an empty vector is returned, which signifies no error.

◆ Validate() [2/3]

USD_API UsdValidationErrorVector Validate ( const UsdPrim & usdPrim ) const

Run validation on the given usdPrim by executing the contained validateTaskFn and returns UsdValidationErrorVector.

If this Validator doesn't provide a UsdValidatePrimTaskFn, then an empty vector is returned, which signifies no error.

◆ Validate() [3/3]

USD_API UsdValidationErrorVector Validate ( const UsdStagePtr & usdStage ) const

Run validation on the given usdStage by executing the contained validateTaskFn and returns UsdValidationErrorVector.

If this Validator doesn't provide a UsdValidateStageTaskFn, then an empty vector is returned, which signifies no error.

Friends And Related Function Documentation

◆ UsdValidationContext

friend class UsdValidationContext

friend

Definition at line 196 of file validator.h.

◆ UsdValidationRegistry

friend class UsdValidationRegistry