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

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

Inheritance diagram for mi::neuraylib::IType_list:
mi::base::Interface_declare< 0x68a97390, 0x22ea, 0x4f03, 0xa5, 0xb5, 0x5c, 0x18, 0x32, 0x38, 0x28, 0x91 > 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 type. More...
 
virtual const char * get_name (Size index) const =0
 Returns the name for the given index, or NULL if there is no such type. More...
 
virtual const ITypeget_type (Size index) const =0
 Returns the type for index, or NULL if there is no such type. More...
 
template<class T >
const T * get_type (Size index) const
 Returns the type for index, or NULL if there is no such type. More...
 
virtual const ITypeget_type (const char *name) const =0
 Returns the type for name, or NULL if there is no such type. More...
 
template<class T >
const T * get_type (const char *name) const
 Returns the type for name, or NULL if there is no such type. More...
 
virtual Sint32 set_type (Size index, const IType *type)=0
 Sets a type at a given index. More...
 
virtual Sint32 set_type (const char *name, const IType *type)=0
 Sets a type identified by name. More...
 
virtual Sint32 add_type (const char *name, const IType *type)=0
 Adds a type at the end of the list. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x68a97390, 0x22ea, 0x4f03, 0xa5, 0xb5, 0x5c, 0x18, 0x32, 0x38, 0x28, 0x91 >
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< 0x68a97390, 0x22ea, 0x4f03, 0xa5, 0xb5, 0x5c, 0x18, 0x32, 0x38, 0x28, 0x91 >
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 types identified by name or index.

Type lists can be created with mi::neuraylib::IType_factory::create_type_list().

Member Function Documentation

virtual Sint32 mi::neuraylib::IType_list::add_type ( const char *  name,
const IType type 
)
pure virtual

Adds a type at the end of the list.

Returns
- 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: There is already a type mapped to name in the list.
virtual Size mi::neuraylib::IType_list::get_index ( const char *  name) const
pure virtual

Returns the index for the given name, or -1 if there is no such type.

virtual const char* mi::neuraylib::IType_list::get_name ( Size  index) const
pure virtual

Returns the name for the given index, or NULL if there is no such type.

virtual Size mi::neuraylib::IType_list::get_size ( ) const
pure virtual

Returns the number of elements.

virtual const IType* mi::neuraylib::IType_list::get_type ( Size  index) const
pure virtual

Returns the type for index, or NULL if there is no such type.

template<class T >
const T* mi::neuraylib::IType_list::get_type ( Size  index) const
inline

Returns the type for index, or NULL if there is no such type.

virtual const IType* mi::neuraylib::IType_list::get_type ( const char *  name) const
pure virtual

Returns the type for name, or NULL if there is no such type.

template<class T >
const T* mi::neuraylib::IType_list::get_type ( const char *  name) const
inline

Returns the type for name, or NULL if there is no such type.

virtual Sint32 mi::neuraylib::IType_list::set_type ( Size  index,
const IType type 
)
pure virtual

Sets a type at a given index.

Returns
- 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: index is out of bounds.
virtual Sint32 mi::neuraylib::IType_list::set_type ( const char *  name,
const IType type 
)
pure virtual

Sets a type identified by name.

Returns
- 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: There is no type mapped to name in the list.