mi::neuraylib::IValue_enum Class Reference
[MDL type system]
Description
A value of type enum.
Public Member Functions
- virtual Size get_index() const =0
- Returns the index of this enum value.
- virtual const char* get_name() const =0
- Returns the string representation of this enum value.
- virtual const IType_enum* get_type() const =0
- Returns the type of this value.
- virtual Sint32 get_value() const =0
- Returns the (integer) value of this enum value.
- virtual Sint32 set_index( Size index) =0
- Sets the enum value by index. More...
- virtual Sint32 set_name( const char* name) =0
- Sets the enum value by string representation in linear time. More...
- virtual Sint32 set_value( Sint32 value) =0
- Sets the enum value by integer in linear time. More...
Static Public Variables
Member Functions
- virtual Size mi::neuraylib::IValue_enum::get_index() const [pure virtual]
-
Returns the index of this enum value.
- virtual const char* mi::neuraylib::IValue_enum::get_name() const [pure virtual]
-
Returns the string representation of this enum value.
- virtual const IType_enum* mi::neuraylib::IValue_enum::get_type() const [pure virtual]
-
Returns the type of this value.
- virtual Sint32 mi::neuraylib::IValue_enum::get_value() const [pure virtual]
-
Returns the (integer) value of this enum value.
- virtual Sint32 mi::neuraylib::IValue_enum::set_index( Size index) [pure virtual]
-
Sets the enum value by index.
Returns
0 in case of success, -1 if index is not valid for this enum type
- virtual Sint32 mi::neuraylib::IValue_enum::set_name( const char* name) [pure virtual]
-
Sets the enum value by string representation in linear time.
Returns
0 in case of success, -1 if name is not valid for this enum type
- virtual Sint32 mi::neuraylib::IValue_enum::set_value( Sint32 value) [pure virtual]
-
Sets the enum value by integer in linear time. If there are multiple indices with the same value the one with the smallest index is chosen.
Returns
0 in case of success, -1 if value is not valid for this enum type
Variables
- const Kind mi::neuraylib::IValue_enum::s_kind = VK_ENUM [static]
-
The kind of this subclass.