HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
SdrSdfTypeIndicator Class Reference

#include <sdfTypeIndicator.h>

Public Member Functions

SDR_API SdrSdfTypeIndicator ()
 Default constructor. More...
 
SDR_API SdrSdfTypeIndicator (const SdfValueTypeName &sdfType, const TfToken &sdrType, bool hasSdfTypeMapping=true)
 
SDR_API TfToken GetSdrType () const
 
SDR_API bool HasSdfType () const
 
SDR_API SdfValueTypeName GetSdfType () const
 
SDR_API bool operator== (const SdrSdfTypeIndicator &rhs) const
 Equality operation. More...
 
SDR_API bool operator!= (const SdrSdfTypeIndicator &rhs) const
 Inequality operation. More...
 

Detailed Description

Represents a mapping from an Sdr Property type to Sdf type.

If an exact mapping exists from Sdr Property type to Sdf type, HasSdfType() will return true, and GetSdfType() will return the Sdf type resulting from the conversion. GetSdrType() will return the original Sdr Property type.

If a mapping doesn't exist from Sdr Property type to Sdf type, HasSdfType() will return false, and GetSdfType() will return either SdfValueTypeNames->TokenArray or SdfValueTypeNames->Token. GetSdrType() will return the original Sdr Property type.

Definition at line 32 of file sdfTypeIndicator.h.

Constructor & Destructor Documentation

SDR_API SdrSdfTypeIndicator::SdrSdfTypeIndicator ( )

Default constructor.

SDR_API SdrSdfTypeIndicator::SdrSdfTypeIndicator ( const SdfValueTypeName &  sdfType,
const TfToken &  sdrType,
bool  hasSdfTypeMapping = true 
)

Constructor. The sdfType must be TokenArray or Token if hasSdfTypeMapping is set to false.

Member Function Documentation

SDR_API SdfValueTypeName SdrSdfTypeIndicator::GetSdfType ( ) const

Gets the Sdf type associated with the represented Sdr property type to Sdf type mapping. If there is no valid Sdf type, either SdfValueTypeNames->TokenArray or SdfValueTypeNames->Token is returned.

SDR_API TfToken SdrSdfTypeIndicator::GetSdrType ( ) const

Gets the original Sdr property type associated with the represented Sdr property type to Sdf type mapping.

SDR_API bool SdrSdfTypeIndicator::HasSdfType ( ) const

Whether an exact Sdf type exists for the represented Sdr property type to Sdf type mapping.

SDR_API bool SdrSdfTypeIndicator::operator!= ( const SdrSdfTypeIndicator &  rhs) const

Inequality operation.

SDR_API bool SdrSdfTypeIndicator::operator== ( const SdrSdfTypeIndicator &  rhs) const

Equality operation.

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