UsdValidatorSuite Class Reference

UsdValidatorSuite acts like a suite for a collection of tests, which clients can use to bundle all tests relevant to test their concepts. More...

#include <validator.h>

Public Member Functions
USD_API	UsdValidatorSuite (const UsdValidatorMetadata &metadata, const std::vector< const UsdValidator * > &validators)
	Instantiate UsdValidatorSuite using metadata and a vector of validators.
	UsdValidatorSuite (UsdValidatorSuite &&other) noexcept=default
UsdValidatorSuite &	operator= (UsdValidatorSuite &&) noexcept=default
const std::vector< const UsdValidator * > &	GetContainedValidators () const &
	Returns a vector of const UsdValidator pointers, which make this UsdValidatorSuite.
std::vector< const UsdValidator * >	GetContainedValidators () &&
	Returns a vector of const UsdValidator pointers, which make this UsdValidatorSuite.
const UsdValidatorMetadata &	GetMetadata () const &
	Return metadata associated with this validator.
UsdValidatorMetadata	GetMetadata () &&
	Return metadata associated with this validator.

Detailed Description

UsdValidatorSuite acts like a suite for a collection of tests, which clients can use to bundle all tests relevant to test their concepts.

If client failed to provide isSuite metadata for a UsdValidatorSuite instance then the validatorSuite will not be registered, and client will appropriately be warned.

UsdValidatorSuite instances are immutable and non-copyable. Note that all validator suites which are registered with the UsdValidationRegistry are immortal.

See also

UsdValidationRegistry

Definition at line 231 of file validator.h.

Constructor & Destructor Documentation

UsdValidatorSuite()

USD_API UsdValidatorSuite	(	const UsdValidatorMetadata &	metadata,
		const std::vector< const UsdValidator * > &	validators
	)

Instantiate UsdValidatorSuite using metadata and a vector of validators.

Member Function Documentation

GetContainedValidators() [1/2]

std::vector< const UsdValidator * > GetContainedValidators ( ) &&

inline

Returns a vector of const UsdValidator pointers, which make this UsdValidatorSuite.

Note that the validators are guaranteed to be valid, since their lifetime is managed by the UsdValidationRegistry, which has a higher scope than individual validators.

Definition at line 257 of file validator.h.

GetContainedValidators() [2/2]

const std::vector< const UsdValidator * > & GetContainedValidators ( ) const &

inline

Returns a vector of const UsdValidator pointers, which make this UsdValidatorSuite.

Note that the validators are guaranteed to be valid, since their lifetime is managed by the UsdValidationRegistry, which has a higher scope than individual validators.

Definition at line 248 of file validator.h.

GetMetadata() [1/2]

UsdValidatorMetadata GetMetadata ( ) &&

inline

Return metadata associated with this validator.

Definition at line 269 of file validator.h.

GetMetadata() [2/2]

const UsdValidatorMetadata & GetMetadata ( ) const &

inline

Return metadata associated with this validator.

Definition at line 263 of file validator.h.

---

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

• pxr/usd/usd/validator.h