mi::neuraylib::IValue_list Class Reference
[MDL type system]
Description
An ordered collection of values identified by name or index. Value lists can be created with mi::neuraylib::IValue_factory::create_value_list().
Public Member Functions
- virtual Sint32 add_value( const char* name, const IValue* value) =0
- Adds a value at the end of the list. More...
- virtual Size get_index( const char* name) const =0
- Returns the index for the given name, or -1 if there is no such value.
- virtual const char* get_name( Size index) const =0
- Returns the name for the given index, or NULL if there is no such value.
- virtual Size get_size() const =0
- Returns the number of elements.
- virtual const IValue* get_value( Size index) const =0
- Returns the value for index, or NULL if there is no such value.
- template< class T>const T* get_value( Size index) const
- Returns the value for index, or NULL if there is no such value.
- virtual const IValue* get_value( const char* name) const =0
- Returns the value for name, or NULL if there is no such value.
- template< class T>const T* get_value( const char* name) const
- Returns the value for name, or NULL if there is no such value.
- virtual Sint32 set_value( Size index, const IValue* value) =0
- Sets a value at a given index. More...
- virtual Sint32 set_value( const char* name, const IValue* value) =0
- Sets a value identified by name. More...
Member Functions
- virtual Sint32 mi::neuraylib::IValue_list::add_value( const char* name, const IValue* value) [pure virtual]
-
Adds a value at the end of the list.
Returns
- 0: Success.
- -1: Invalid parameter (NULL pointer).
- -2: There is already a value mapped to name in the list.
- virtual Size mi::neuraylib::IValue_list::get_index( const char* name) const [pure virtual]
-
Returns the index for the given name, or -1 if there is no such value.
- virtual const char* mi::neuraylib::IValue_list::get_name( Size index) const [pure virtual]
-
Returns the name for the given index, or NULL if there is no such value.
- virtual Size mi::neuraylib::IValue_list::get_size() const [pure virtual]
-
Returns the number of elements.
- virtual const IValue* mi::neuraylib::IValue_list::get_value( Size index) const [pure virtual]
-
Returns the value for index, or NULL if there is no such value.
-
template< class T>
const T* mi::neuraylib::IValue_list::get_value( Size index) const [inline] -
Returns the value for index, or NULL if there is no such value.
- virtual const IValue* mi::neuraylib::IValue_list::get_value( const char* name) const [pure virtual]
-
Returns the value for name, or NULL if there is no such value.
-
template< class T>
const T* mi::neuraylib::IValue_list::get_value( const char* name) const [inline] -
Returns the value for name, or NULL if there is no such value.
- virtual Sint32 mi::neuraylib::IValue_list::set_value( Size index, const IValue* value) [pure virtual]
-
Sets a value at a given index.
Returns
- 0: Success.
- -1: Invalid parameter (NULL pointer).
- -2: index is out of bounds.
- virtual Sint32 mi::neuraylib::IValue_list::set_value( const char* name, const IValue* value) [pure virtual]
-
Sets a value identified by name.
Returns
- 0: Success.
- -1: Invalid parameter (NULL pointer).
- -2: There is no value mapped to name in the list.