HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdValidationValidatorSuite Class Reference

#include <validator.h>

Public Member Functions

USDVALIDATION_API UsdValidationValidatorSuite (const UsdValidationValidatorMetadata &metadata, const std::vector< const UsdValidationValidator * > &validators)
 
 UsdValidationValidatorSuite (UsdValidationValidatorSuite &&other) noexcept=default
 
UsdValidationValidatorSuiteoperator= (UsdValidationValidatorSuite &&) noexcept=default
 
const std::vector< const
UsdValidationValidator * > & 
GetContainedValidators () const &
 
std::vector< const
UsdValidationValidator * > 
GetContainedValidators ()&&
 
const
UsdValidationValidatorMetadata
GetMetadata () const &
 Return metadata associated with this validator. More...
 
UsdValidationValidatorMetadata GetMetadata ()&&
 Return metadata associated with this validator. More...
 

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

Constructor & Destructor Documentation

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

Instantiate UsdValidationValidatorSuite using metadata and a vector of validators.

UsdValidationValidatorSuite::UsdValidationValidatorSuite ( UsdValidationValidatorSuite &&  other)
defaultnoexcept

Member Function Documentation

const std::vector<const UsdValidationValidator *>& UsdValidationValidatorSuite::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 284 of file validator.h.

std::vector<const UsdValidationValidator *> UsdValidationValidatorSuite::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 294 of file validator.h.

const UsdValidationValidatorMetadata& UsdValidationValidatorSuite::GetMetadata ( ) const
inline

Return metadata associated with this validator.

Definition at line 300 of file validator.h.

UsdValidationValidatorMetadata UsdValidationValidatorSuite::GetMetadata ( )
inline

Return metadata associated with this validator.

Definition at line 306 of file validator.h.

UsdValidationValidatorSuite& UsdValidationValidatorSuite::operator= ( UsdValidationValidatorSuite &&  )
defaultnoexcept

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