SdfSchemaBase::SpecDefinition Class Reference

Class representing fields and other information for a spec type. More...

Public Member Functions
SDF_API TfTokenVector	GetFields () const
	Returns all fields for this spec. More...
TfTokenVector const &	GetRequiredFields () const
	Returns all value fields marked as required for this spec. More...
SDF_API TfTokenVector	GetMetadataFields () const
	Returns all value fields marked as metadata for this spec. More...
SDF_API bool	IsValidField (const TfToken &name) const
	Returns whether the given field is valid for this spec. More...
SDF_API bool	IsMetadataField (const TfToken &name) const
	Returns whether the given field is metadata for this spec. More...
SDF_API TfToken	GetMetadataFieldDisplayGroup (const TfToken &name) const
	Returns the display group for this metadata field. More...
SDF_API bool	IsRequiredField (const TfToken &name) const
	Returns whether the given field is required for this spec. More...

Friends
class	_SpecDefiner

Detailed Description

Class representing fields and other information for a spec type.

Definition at line 177 of file schema.h.

Member Function Documentation

GetFields()

SDF_API TfTokenVector GetFields

(

)

const

Returns all fields for this spec.

GetMetadataFieldDisplayGroup()

SDF_API TfToken GetMetadataFieldDisplayGroup

(

const TfToken &

name

)

const

Returns the display group for this metadata field.

Returns the empty token if this field is not a metadata field or if this metadata field has no display group.

GetMetadataFields()

SDF_API TfTokenVector GetMetadataFields

(

)

const

Returns all value fields marked as metadata for this spec.

GetRequiredFields()

TfTokenVector const& GetRequiredFields ( ) const

inline

Returns all value fields marked as required for this spec.

Definition at line 183 of file schema.h.

IsMetadataField()

SDF_API bool IsMetadataField

(

const TfToken &

name

)

const

Returns whether the given field is metadata for this spec.

IsRequiredField()

SDF_API bool IsRequiredField

(

const TfToken &

name

)

const

Returns whether the given field is required for this spec.

IsValidField()

SDF_API bool IsValidField

(

const TfToken &

name

)

const

Returns whether the given field is valid for this spec.

---

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

• pxr/usd/sdf/schema.h