Material Definition Language API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IValue_enum Class Referenceabstract

A value of type enum. More...

Inheritance diagram for mi::neuraylib::IValue_enum:
mi::base::Interface_declare< 0xdc876204, 0x8a97, 0x40e9, 0xb9, 0xb6, 0xca, 0xdc, 0xdd, 0x60, 0x1f, 0xbf, neuraylib::IValue_atomic > mi::neuraylib::IValue_atomic mi::base::Interface_declare< 0xf2413c80, 0x8e71, 0x4974, 0xaa, 0xf2, 0x60, 0xd5, 0xe2, 0x94, 0x9d, 0x3e, neuraylib::IValue > mi::neuraylib::IValue mi::base::Interface_declare< 0xbf837f4a, 0x9034, 0x4f32, 0xaf, 0x5c, 0x75, 0xb3, 0x67, 0x64, 0x53, 0x23 > mi::base::IInterface

Public Member Functions

virtual const IType_enumget_type () const =0
 Returns the type of this value. More...
 
virtual Sint32 get_value () const =0
 Returns the (integer) value of this enum value. More...
 
virtual Size get_index () const =0
 Returns the index of this enum value. More...
 
virtual Sint32 set_value (Sint32 value)=0
 Sets the enum value by integer in linear time. More...
 
virtual Sint32 set_index (Size index)=0
 Sets the enum value by index. More...
 
virtual const char * get_name () const =0
 Returns the string representation of this enum value. More...
 
virtual Sint32 set_name (const char *name)=0
 Sets the enum value by string representation in linear time. More...
 

Static Public Attributes

static const Kind s_kind = VK_ENUM
 The kind of this subclass. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xdc876204, 0x8a97, 0x40e9, 0xb9, 0xb6, 0xca, 0xdc, 0xdd, 0x60, 0x1f, 0xbf, neuraylib::IValue_atomic >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
neuraylib::IValue_atomic
Self
 Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xdc876204, 0x8a97, 0x40e9, 0xb9, 0xb6, 0xca, 0xdc, 0xdd, 0x60, 0x1f, 0xbf, neuraylib::IValue_atomic >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

A value of type enum.

Member Function Documentation

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.

Implements mi::neuraylib::IValue_atomic.

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

Member Data Documentation

const Kind mi::neuraylib::IValue_enum::s_kind = VK_ENUM
static

The kind of this subclass.