Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
SdfSchemaBase::FieldDefinition Class Reference

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

#include <schema.h>

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.
 
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.
 
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 73 of file schema.h.

Member Typedef Documentation

◆ InfoVec

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

Definition at line 80 of file schema.h.

◆ Validator

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

Definition at line 138 of file schema.h.

Member Function Documentation

◆ FallbackValue()

FieldDefinition & FallbackValue ( const VtValue &  v)

Functions for setting field attributes during registration.

◆ IsValidListValue()

SdfAllowed IsValidListValue ( const T &  value) const
inline

Definition at line 103 of file schema.h.

◆ IsValidMapKey()

SdfAllowed IsValidMapKey ( const T &  value) const
inline

Definition at line 111 of file schema.h.

◆ IsValidMapValue()

SdfAllowed IsValidMapValue ( const T &  value) const
inline

Definition at line 119 of file schema.h.

◆ IsValidValue()

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 95 of file schema.h.

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