mi::neuraylib::IValue_list Class Reference

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

#include <ivalue.h>

Inheritance diagram for mi::neuraylib::IValue_list:

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 IValue *	get_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 IValue *	get_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...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x8027a5e5, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x8027a5e5, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. 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

add_value()

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.

get_index()

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.

get_name()

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.

get_size()

virtual Size mi::neuraylib::IValue_list::get_size ( ) const

pure virtual

Returns the number of elements.

get_value() [1/4]

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.

get_value() [2/4]

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.

get_value() [3/4]

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.

get_value() [4/4]

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.

set_value() [1/2]

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.

set_value() [2/2]

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.