Class defining various attributes for a field. More...

Public Types
typedef std::vector< std::pair < TfToken, JsValue > >	InfoVec

Public Member Functions
	FieldDefinition (const SdfSchemaBase &schema, const TfToken &name, const VtValue &fallbackValue)

SDF_API const TfToken &	GetName () const

SDF_API const VtValue &	GetFallbackValue () const

SDF_API const InfoVec &	GetInfo () const

SDF_API bool	IsPlugin () const

SDF_API bool	IsReadOnly () const

SDF_API bool	HoldsChildren () const


template<class T >
SdfAllowed	IsValidValue (const T &value) const
	Validation functions that return true if a given value passes the registered validator or if no validator has been set. More...

template<class T >
SdfAllowed	IsValidListValue (const T &value) const

template<class T >
SdfAllowed	IsValidMapKey (const T &value) const

template<class T >
SdfAllowed	IsValidMapValue (const T &value) const

using	Validator = SdfAllowed(*)(const SdfSchemaBase &, const VtValue &)

FieldDefinition &	FallbackValue (const VtValue &v)
	Functions for setting field attributes during registration. More...

FieldDefinition &	Plugin ()

FieldDefinition &	Children ()

FieldDefinition &	ReadOnly ()

FieldDefinition &	AddInfo (const TfToken &tok, const JsValue &val)

FieldDefinition &	ValueValidator (Validator v)

FieldDefinition &	ListValueValidator (Validator v)

FieldDefinition &	MapKeyValidator (Validator v)

FieldDefinition &	MapValueValidator (Validator v)

Detailed Description

Class defining various attributes for a field.

Definition at line 72 of file schema.h.

Member Function Documentation

FieldDefinition& FallbackValue ( const VtValue & v )

Functions for setting field attributes during registration.

SdfAllowed IsValidValue ( const T & value ) const

inline

Validation functions that return true if a given value passes the registered validator or if no validator has been set.

Definition at line 94 of file schema.h.

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