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

#include <schema.h>

Public Member Functions

SDF_API TfTokenVector GetFields () const
 Returns all fields for this spec. More...
 
SDF_API TfTokenVector 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
 
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

SDF_API TfTokenVector SdfSchemaBase::SpecDefinition::GetFields ( ) const

Returns all fields for this spec.

SDF_API TfToken SdfSchemaBase::SpecDefinition::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.

SDF_API TfTokenVector SdfSchemaBase::SpecDefinition::GetMetadataFields ( ) const

Returns all value fields marked as metadata for this spec.

SDF_API TfTokenVector SdfSchemaBase::SpecDefinition::GetRequiredFields ( ) const

Returns all value fields marked as required for this spec.

SDF_API bool SdfSchemaBase::SpecDefinition::IsMetadataField ( const TfToken name) const

Returns whether the given field is metadata for this spec.

SDF_API bool SdfSchemaBase::SpecDefinition::IsRequiredField ( const TfToken name) const

Returns whether the given field is required for this spec.

SDF_API bool SdfSchemaBase::SpecDefinition::IsValidField ( const TfToken name) const

Returns whether the given field is valid for this spec.

Friends And Related Function Documentation

friend class _SpecDefiner
friend

Definition at line 210 of file schema.h.


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