All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SdfUnregisteredValue Class Reference

Stores a representation of the value for an unregistered metadata field encountered during text layer parsing. More...

Inherits equality_comparable< SdfUnregisteredValue >.

Public Member Functions

SDF_API SdfUnregisteredValue ()
 Wraps an empty VtValue. More...
 
SDF_API SdfUnregisteredValue (const std::string &value)
 Wraps a std::string. More...
 
SDF_API SdfUnregisteredValue (const VtDictionary &value)
 Wraps a VtDictionary. More...
 
SDF_API SdfUnregisteredValue (const SdfUnregisteredValueListOp &value)
 Wraps a SdfUnregisteredValueListOp. More...
 
const VtValueGetValue () const
 Returns the wrapped VtValue specified in the constructor. More...
 
SDF_API bool operator== (const SdfUnregisteredValue &other) const
 Returns true if the wrapped VtValues are equal. More...
 

Friends

size_t hash_value (const SdfUnregisteredValue &uv)
 Hash. More...
 

Detailed Description

Stores a representation of the value for an unregistered metadata field encountered during text layer parsing.

This provides the ability to serialize this data to a layer, as well as limited inspection and editing capabilities (e.g., moving this data to a different spec or field) even when the data type of the value isn't known.

Definition at line 441 of file types.h.

Constructor & Destructor Documentation

SDF_API SdfUnregisteredValue ( )

Wraps an empty VtValue.

SDF_API SdfUnregisteredValue ( const std::string &  value)
explicit

Wraps a std::string.

SDF_API SdfUnregisteredValue ( const VtDictionary value)
explicit

Wraps a VtDictionary.

SDF_API SdfUnregisteredValue ( const SdfUnregisteredValueListOp &  value)
explicit

Wraps a SdfUnregisteredValueListOp.

Member Function Documentation

const VtValue& GetValue ( ) const
inline

Returns the wrapped VtValue specified in the constructor.

Definition at line 458 of file types.h.

SDF_API bool operator== ( const SdfUnregisteredValue other) const

Returns true if the wrapped VtValues are equal.

Friends And Related Function Documentation

size_t hash_value ( const SdfUnregisteredValue uv)
friend

Hash.

Definition at line 463 of file types.h.


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