HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_OptionEntryImpl< T, ID > Class Template Reference

#include <UT_OptionEntry.h>

+ Inheritance diagram for UT_OptionEntryImpl< T, ID >:

Public Types

typedef T value_type
 
- Public Types inherited from UT_OptionEntry
enum  UT_OptionTypeStorage {
  UT_OPTION_STORE_INVALID =-1, UT_OPTION_STORE_BOOL, UT_OPTION_STORE_INT, UT_OPTION_STORE_REAL,
  UT_OPTION_STORE_STRING, UT_OPTION_STORE_DICT
}
 

Public Member Functions

 UT_OptionEntryImpl (const T &value)
 
 ~UT_OptionEntryImpl () override
 
const TgetValue () const
 
UT_OptionType getType () const override
 
UT_OptionEntryPtr clone () const override
 
int64 getMemoryUsage (bool inclusive) const override
 
- Public Member Functions inherited from UT_OptionEntry
 UT_OptionEntry ()
 
virtual ~UT_OptionEntry ()
 
 UT_OptionEntry (const UT_OptionEntry &)=delete
 
UT_OptionEntryoperator= (const UT_OptionEntry &)=delete
 
unsigned hash () const
 Hash a single option entry. More...
 
unsigned isEqual (const UT_OptionEntry &cmp, fpreal64 tolerance=0.0) const
 Compute equivalence for a given option entry. More...
 
bool getOptionString (UT_OptionFormat format, UT_WorkBuffer &result) const
 
bool getOptionString (UT_OptionFormat format, UT_String &result) const
 
UT_OptionTypeStorage optionStorage () const
 
exint optionSize () const
 
bool importOption (int64 &value) const
 
bool importOption (bool &value) const
 
bool importOption (fpreal64 &value) const
 
bool importOption (UT_StringHolder &value) const
 
bool importOption (UT_OptionsHolder &value) const
 
bool importOption (UT_Vector2D &value) const
 
bool importOption (UT_Vector3D &value) const
 
bool importOption (UT_Vector4D &value) const
 
bool importOption (UT_QuaternionD &value) const
 
bool importOption (UT_Matrix2D &value) const
 
bool importOption (UT_Matrix3D &value) const
 
bool importOption (UT_Matrix4D &value) const
 
bool importOption (UT_Array< int32 > &value) const
 
bool importOption (UT_Array< int64 > &value) const
 
bool importOption (UT_Array< fpreal32 > &value) const
 
bool importOption (UT_Array< fpreal64 > &value) const
 
bool importOption (UT_StringArray &value) const
 
bool importOption (UT_Array< UT_StringHolder > &value) const
 
bool importOption (UT_Array< UT_OptionsHolder > &value) const
 
int64 getOptionI () const
 
bool getOptionB () const
 
fpreal64 getOptionF () const
 
const UT_Vector2DgetOptionV2 () const
 
const UT_Vector3DgetOptionV3 () const
 
const UT_Vector4DgetOptionV4 () const
 
const UT_QuaternionDgetOptionQ () const
 
const UT_Matrix2DgetOptionM2 () const
 
const UT_Matrix3DgetOptionM3 () const
 
const UT_Matrix4DgetOptionM4 () const
 
const UT_Vector2DgetOptionUV () const
 
const UT_Vector3DgetOptionUVW () const
 
UT_StringHolder getOptionS () const
 
const UT_OptionsHoldergetOptionDict () const
 
const UT_Int64ArraygetOptionIArray () const
 
const UT_Fpreal64ArraygetOptionFArray () const
 
const UT_StringArraygetOptionSArray () const
 
const UT_Array
< UT_OptionsHolder > & 
getOptionDictArray () const
 
bool saveJSON (UT_JSONWriter &w, bool compact) const
 
void saveJSON (UT_JSONValue &v, bool compact) const
 

Protected Attributes

T myValue
 

Additional Inherited Members

- Static Public Member Functions inherited from UT_OptionEntry
static UT_OptionTypeStorage optionStorage (UT_OptionType t)
 Return the underlying storage type for the option. More...
 
static exint optionSize (UT_OptionType t)
 Returns the tuple size, or 0 if the option is variadic (i.e. INTARRAY) More...
 
static UT_OptionEntryPtr createEntry (const UT_JSONValue &v, bool allow_type=true, bool allow_dict=false)
 
static UT_OptionEntryPtr createEntryFromTypedMap (const UT_JSONValueMap &map, UT_String &error_str)
 
static UT_OptionType getOptionTypeFromString (const char *optiontypestr)
 Convert string to and from UT_OptionType values. More...
 
static const char * getStringFromOptionType (UT_OptionType optiontype)
 
- Static Public Member Functions inherited from UT_SmallObject< UT_OptionEntry, UT_SMALLOBJECT_CLEANPAGES_DEFAULT, UT_SMALLOBJECT_PAGESIZE_DEFAULT, UT_SMALLOBJECT_THREADSAFE_ON >
static voidoperator new (size_t size)
 Regular new/delete operators. More...
 
static void operator delete (void *p, size_t size)
 Regular new/delete operators. More...
 
static voidoperator new (size_t, void *p)
 
static void operator delete (void *, void *)
 

Detailed Description

template<class T, UT_OptionType ID>
class UT_OptionEntryImpl< T, ID >

Definition at line 266 of file UT_OptionEntry.h.

Member Typedef Documentation

template<class T, UT_OptionType ID>
typedef T UT_OptionEntryImpl< T, ID >::value_type

Definition at line 269 of file UT_OptionEntry.h.

Constructor & Destructor Documentation

template<class T, UT_OptionType ID>
UT_OptionEntryImpl< T, ID >::UT_OptionEntryImpl ( const T value)
inline

Definition at line 271 of file UT_OptionEntry.h.

template<class T, UT_OptionType ID>
UT_OptionEntryImpl< T, ID >::~UT_OptionEntryImpl ( )
inlineoverride

Definition at line 274 of file UT_OptionEntry.h.

Member Function Documentation

template<class T, UT_OptionType ID>
UT_OptionEntryPtr UT_OptionEntryImpl< T, ID >::clone ( ) const
inlineoverridevirtual

Reimplemented from UT_OptionEntry.

Definition at line 281 of file UT_OptionEntry.h.

template<class T, UT_OptionType ID>
int64 UT_OptionEntryImpl< T, ID >::getMemoryUsage ( bool  inclusive) const
inlineoverridevirtual

Reimplemented from UT_OptionEntry.

Definition at line 286 of file UT_OptionEntry.h.

template<class T, UT_OptionType ID>
UT_OptionType UT_OptionEntryImpl< T, ID >::getType ( ) const
inlineoverridevirtual

Reimplemented from UT_OptionEntry.

Definition at line 279 of file UT_OptionEntry.h.

template<class T, UT_OptionType ID>
const T& UT_OptionEntryImpl< T, ID >::getValue ( ) const
inline

Definition at line 277 of file UT_OptionEntry.h.

Member Data Documentation

template<class T, UT_OptionType ID>
T UT_OptionEntryImpl< T, ID >::myValue
protected

Definition at line 293 of file UT_OptionEntry.h.


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