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

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

Inheritance diagram for mi::neuraylib::IExpression_list:
mi::base::Interface_declare< 0x98ce8e89, 0x9f23, 0x45ec, 0xa7, 0xce, 0x85, 0x78, 0x48, 0x14, 0x85, 0x23 > 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 expression. More...
 
virtual const char * get_name (Size index) const =0
 Returns the name for the given index, or NULL if there is no such expression. More...
 
virtual const IExpressionget_expression (Size index) const =0
 Returns the expression for index, or NULL if there is no such expression. More...
 
template<class T >
const T * get_expression (Size index) const
 Returns the expression for index, or NULL if there is no such expression. More...
 
virtual const IExpressionget_expression (const char *name) const =0
 Returns the expression for name, or NULL if there is no such expression. More...
 
template<class T >
const T * get_expression (const char *name) const
 Returns the expression for name, or NULL if there is no such expression. More...
 
virtual Sint32 set_expression (Size index, const IExpression *expression)=0
 Sets an expression at a given index. More...
 
virtual Sint32 set_expression (const char *name, const IExpression *expression)=0
 Sets an expression identified by name. More...
 
virtual Sint32 add_expression (const char *name, const IExpression *expression)=0
 Adds an expression at the end of the list. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x98ce8e89, 0x9f23, 0x45ec, 0xa7, 0xce, 0x85, 0x78, 0x48, 0x14, 0x85, 0x23 >
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< 0x98ce8e89, 0x9f23, 0x45ec, 0xa7, 0xce, 0x85, 0x78, 0x48, 0x14, 0x85, 0x23 >
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 expressions identified by name or index.

Expression lists can be created with mi::neuraylib::IExpression_factory::create_expression_list().

Member Function Documentation

virtual Sint32 mi::neuraylib::IExpression_list::add_expression ( const char *  name,
const IExpression expression 
)
pure virtual

Adds an expression at the end of the list.

Returns
- 0: Success.
  • -1: Invalid parameter (NULL pointer).
  • -2: There is already an expression mapped to name in the list.
virtual const IExpression* mi::neuraylib::IExpression_list::get_expression ( Size  index) const
pure virtual

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

template<class T >
const T* mi::neuraylib::IExpression_list::get_expression ( Size  index) const
inline

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

virtual const IExpression* mi::neuraylib::IExpression_list::get_expression ( const char *  name) const
pure virtual

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

template<class T >
const T* mi::neuraylib::IExpression_list::get_expression ( const char *  name) const
inline

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

virtual Size mi::neuraylib::IExpression_list::get_index ( const char *  name) const
pure virtual

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

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

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

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

Returns the number of elements.

virtual Sint32 mi::neuraylib::IExpression_list::set_expression ( Size  index,
const IExpression expression 
)
pure virtual

Sets an expression at a given index.

Returns
- 0: Success.
  • -1: Invalid parameter (NULL pointer).
  • -2: index is out of bounds.
virtual Sint32 mi::neuraylib::IExpression_list::set_expression ( const char *  name,
const IExpression expression 
)
pure virtual

Sets an expression identified by name.

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