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

An ordered collection of values identified by name or index. More...

Inheritance diagram for mi::neuraylib::IValue_list:
mi::base::Interface_declare< 0x8027a5e5, 0x4e25, 0x410c, 0xbb, 0xce, 0x84, 0xb4, 0x88, 0x8b, 0x03, 0x46 > mi::base::IInterface

Public Member Functions

virtual Size get_size () const =0
 Returns the number of elements. 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. More...
 
virtual const char * get_name (Size index) const =0
 Returns the name for the given index, or NULL if there is no such value. More...
 
virtual const IValueget_value (Size index) const =0
 Returns the value for index, or NULL if there is no such value. More...
 
template<class T >
const T * get_value (Size index) const
 Returns the value for index, or NULL if there is no such value. More...
 
virtual const IValueget_value (const char *name) const =0
 Returns the value for name, or NULL if there is no such value. More...
 
template<class T >
const T * get_value (const char *name) const
 Returns the value for name, or NULL if there is no such value. More...
 
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...
 
virtual Sint32 add_value (const char *name, const IValue *value)=0
 Adds a value at the end of the list. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x8027a5e5, 0x4e25, 0x410c, 0xbb, 0xce, 0x84, 0xb4, 0x88, 0x8b, 0x03, 0x46 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
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< 0x8027a5e5, 0x4e25, 0x410c, 0xbb, 0xce, 0x84, 0xb4, 0x88, 0x8b, 0x03, 0x46 >
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

An ordered collection of values identified by name or index.

Value lists can be created with mi::neuraylib::IValue_factory::create_value_list().

Member Function Documentation

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.