UsdValidationValidatorSuite Class Reference

UsdValidationValidatorSuite 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
USDVALIDATION_API	UsdValidationValidatorSuite (const UsdValidationValidatorMetadata &metadata, const std::vector< const UsdValidationValidator * > &validators)
	Instantiate UsdValidationValidatorSuite using metadata and a vector of validators.
	UsdValidationValidatorSuite (UsdValidationValidatorSuite &&other) noexcept=default
UsdValidationValidatorSuite &	operator= (UsdValidationValidatorSuite &&) noexcept=default
const std::vector< const UsdValidationValidator * > &	GetContainedValidators () const &
	Returns a vector of const UsdValidationValidator pointers, which make this UsdValidationValidatorSuite.
std::vector< const UsdValidationValidator * >	GetContainedValidators () &&
	Returns a vector of const UsdValidationValidator pointers, which make this UsdValidationValidatorSuite.
const UsdValidationValidatorMetadata &	GetMetadata () const &
	Return metadata associated with this validator.
UsdValidationValidatorMetadata	GetMetadata () &&
	Return metadata associated with this validator.

Detailed Description

UsdValidationValidatorSuite 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 UsdValidationValidatorSuite instance then the validatorSuite will not be registered, and client will appropriately be warned.

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

isTimeDependent metadata is a no-op for a UsdValidationValidatorSuite.

See also

UsdValidationRegistry

Definition at line 317 of file validator.h.

Constructor & Destructor Documentation

UsdValidationValidatorSuite()

USDVALIDATION_API UsdValidationValidatorSuite	(	const UsdValidationValidatorMetadata &	metadata,
		const std::vector< const UsdValidationValidator * > &	validators
	)

Instantiate UsdValidationValidatorSuite using metadata and a vector of validators.

Member Function Documentation

GetContainedValidators() [1/2]

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

inline

Returns a vector of const UsdValidationValidator pointers, which make this UsdValidationValidatorSuite.

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 350 of file validator.h.

GetContainedValidators() [2/2]

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

inline

Returns a vector of const UsdValidationValidator pointers, which make this UsdValidationValidatorSuite.

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 340 of file validator.h.

GetMetadata() [1/2]

UsdValidationValidatorMetadata GetMetadata ( ) &&

inline

Return metadata associated with this validator.

Definition at line 362 of file validator.h.

GetMetadata() [2/2]

const UsdValidationValidatorMetadata & GetMetadata ( ) const &

inline

Return metadata associated with this validator.

Definition at line 356 of file validator.h.

---

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

• pxr/usdValidation/usdValidation/validator.h