MDL SDK API nvidia_logo_transpbg.gif Up
Public Member Functions | List of all members
mi::neuraylib::IAnnotation_list Class Referenceabstract
MDL SDK API » MDL type system

An ordered collection of annotation blocks identified by name or index. More...

#include <iexpression.h>

Inheritance diagram for mi::neuraylib::IAnnotation_list:
Inheritance graph
[legend]

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 block. More...
 
virtual const char * get_name (Size index) const =0
 Returns the name for the given index, or nullptr if there is no such block. More...
 
virtual const IAnnotation_block * get_annotation_block (Size index) const =0
 Returns the annotation block for index, or nullptr if there is no such block. More...
 
virtual const IAnnotation_block * get_annotation_block (const char *name) const =0
 Returns the annotation block for name, or nullptr if there is no such block. More...
 
virtual Sint32 set_annotation_block (Size index, const IAnnotation_block *block)=0
 Sets an annotation block at a given index. More...
 
virtual Sint32 set_annotation_block (const char *name, const IAnnotation_block *block)=0
 Sets an annotation block identified by name. More...
 
virtual Sint32 add_annotation_block (const char *name, const IAnnotation_block *block)=0
 Adds an annotation block 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< 0x6c4663c2, ... >
using Self = Interface_declare< id1, ... >
 Own type. More...
 
using IID = Uuid_t< id1, ... >
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
using IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x6c4663c2, ... >
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 annotation blocks identified by name or index.

Annotation lists can be created with mi::neuraylib::IExpression_factory::create_annotation_list().

Member Function Documentation

◆ add_annotation_block()

virtual Sint32 mi::neuraylib::IAnnotation_list::add_annotation_block ( const char *  name,
const IAnnotation_block *  block 
)
pure virtual

Adds an annotation block at the end of the list.

Returns
  • 0: Success.
  • -1: Invalid parameter (nullptr).
  • -2: There is already an annotation block mapped to name in the list.

◆ get_annotation_block() [1/2]

virtual const IAnnotation_block * mi::neuraylib::IAnnotation_list::get_annotation_block ( const char *  name) const
pure virtual

Returns the annotation block for name, or nullptr if there is no such block.

◆ get_annotation_block() [2/2]

virtual const IAnnotation_block * mi::neuraylib::IAnnotation_list::get_annotation_block ( Size  index) const
pure virtual

Returns the annotation block for index, or nullptr if there is no such block.

◆ get_index()

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

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

◆ get_name()

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

Returns the name for the given index, or nullptr if there is no such block.

◆ get_size()

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

Returns the number of elements.

◆ set_annotation_block() [1/2]

virtual Sint32 mi::neuraylib::IAnnotation_list::set_annotation_block ( const char *  name,
const IAnnotation_block *  block 
)
pure virtual

Sets an annotation block identified by name.

Returns
  • 0: Success.
  • -1: Invalid parameter (nullptr).
  • -2: There is no annotation block mapped to name in the list.

◆ set_annotation_block() [2/2]

virtual Sint32 mi::neuraylib::IAnnotation_list::set_annotation_block ( Size  index,
const IAnnotation_block *  block 
)
pure virtual

Sets an annotation block at a given index.

Returns
  • 0: Success.
  • -1: Invalid parameter (nullptr).
  • -2: index is out of bounds.