UsdAttributeLimits::ValidationResult Class Reference

Validation information for a limits sub-dictionary. More...

#include <attributeLimits.h>

Public Member Functions
	ValidationResult ()=default
	Construct an empty result.
bool	Success () const
	Return whether validation was successful.
const VtDictionary &	GetInvalidValuesDict () const
	Return a dictionary containing values from the source sub-dictionary that did not match (and could not be casted to) the attribute's type.
const VtDictionary &	GetConformedSubDict () const
	Return the conformed limits sub-dictionary.
USD_API std::string	GetErrorString () const
	Return a formatted error string describing the keys and values in the invalid values dictionary.
	operator bool () const
	Return true if validation was successful.
bool	operator== (const ValidationResult &rhs) const
	Equality operator.
bool	operator!= (const ValidationResult &rhs) const
	Inequality operator.

Friends
class	UsdAttributeLimits

Detailed Description

Validation information for a limits sub-dictionary.

See also

Validate()

Definition at line 202 of file attributeLimits.h.

Constructor & Destructor Documentation

ValidationResult()

ValidationResult ( )

default

Construct an empty result.

Member Function Documentation

GetConformedSubDict()

const VtDictionary & GetConformedSubDict ( ) const

inline

Return the conformed limits sub-dictionary.

Any values from the source sub-dictionary that were of an unexpected type will have been casted to the attribute's value type, if possible, in the conformed sub-dictionary.

If any unexpected values from the source sub-dictionary could not be casted, they will appear in the invalid values dictionary, and the conformed sub-dictionary will be empty.

Definition at line 231 of file attributeLimits.h.

GetErrorString()

USD_API std::string GetErrorString

(

)

const

Return a formatted error string describing the keys and values in the invalid values dictionary.

Return an empty string if there are no invalid values.

GetInvalidValuesDict()

const VtDictionary & GetInvalidValuesDict ( ) const

inline

Return a dictionary containing values from the source sub-dictionary that did not match (and could not be casted to) the attribute's type.

Only minimum and maximum values must match the attribute's value type. Other keys are not validated.

Definition at line 219 of file attributeLimits.h.

operator bool()

operator bool ( ) const

inlineexplicit

Return true if validation was successful.

See also

Success()

Definition at line 244 of file attributeLimits.h.

operator!=()

bool operator!= ( const ValidationResult &  rhs ) const

inline

Inequality operator.

Definition at line 258 of file attributeLimits.h.

operator==()

bool operator== ( const ValidationResult &  rhs ) const

inline

Equality operator.

Definition at line 249 of file attributeLimits.h.

Success()

bool Success ( ) const

inline

Return whether validation was successful.

Definition at line 209 of file attributeLimits.h.

Friends And Related Function Documentation

UsdAttributeLimits

friend class UsdAttributeLimits

friend

Definition at line 263 of file attributeLimits.h.

---

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

• pxr/usd/usd/attributeLimits.h