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

#include <sdfTypeIndicator.h>

Public Member Functions

NDR_API NdrSdfTypeIndicator ()
 Default constructor. More...
 
NDR_API NdrSdfTypeIndicator (const SdfValueTypeName &sdfType, const TfToken &ndrType, bool hasSdfTypeMapping=true)
 
NDR_API TfToken GetNdrType () const
 
NDR_API TfToken GetSdrType () const
 
NDR_API bool HasSdfType () const
 
NDR_API SdfValueTypeName GetSdfType () const
 
NDR_API bool operator== (const NdrSdfTypeIndicator &rhs) const
 Equality operation. More...
 
NDR_API bool operator!= (const NdrSdfTypeIndicator &rhs) const
 Inequality operation. More...
 

Detailed Description

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

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

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

Deprecated:
Deprecated in favor of SdrSdfTypeIndicator

Definition at line 38 of file sdfTypeIndicator.h.

Constructor & Destructor Documentation

NDR_API NdrSdfTypeIndicator::NdrSdfTypeIndicator ( )

Default constructor.

NDR_API NdrSdfTypeIndicator::NdrSdfTypeIndicator ( const SdfValueTypeName &  sdfType,
const TfToken &  ndrType,
bool  hasSdfTypeMapping = true 
)

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

Member Function Documentation

NDR_API TfToken NdrSdfTypeIndicator::GetNdrType ( ) const

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

Deprecated:
Deprecated in favor of GetSdrType
NDR_API SdfValueTypeName NdrSdfTypeIndicator::GetSdfType ( ) const

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

NDR_API TfToken NdrSdfTypeIndicator::GetSdrType ( ) const

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

NDR_API bool NdrSdfTypeIndicator::HasSdfType ( ) const

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

NDR_API bool NdrSdfTypeIndicator::operator!= ( const NdrSdfTypeIndicator &  rhs) const

Inequality operation.

NDR_API bool NdrSdfTypeIndicator::operator== ( const NdrSdfTypeIndicator &  rhs) const

Equality operation.

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