mi::neuraylib::IAnnotation_list Class Reference
[MDL type system]
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().
Public Member Functions
- virtual Sint32 add_annotation_block( const char* name, const IAnnotation_block* block) =0
- Adds an annotation block at the end of the list. More...
- virtual const IAnnotation_block* get_annotation_block( Size index) const =0
- Returns the annotation block for index, or NULL if there is no such block.
- virtual const IAnnotation_block* get_annotation_block( const char* name) const =0
- Returns the annotation block for name, or NULL if there is no such block.
- virtual Size get_index( const char* name) const =0
- Returns the index for the given name, or -1 if there is no such block.
- virtual const char* get_name( Size index) const =0
- Returns the name for the given index, or NULL if there is no such block.
- virtual Size get_size() const =0
- Returns the number of elements.
- 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...
Member Functions
- 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 (NULL pointer).
- -2: There is already an annotation block mapped to name in the list.
- virtual const IAnnotation_block* mi::neuraylib::IAnnotation_list::get_annotation_block( Size index) const [pure virtual]
-
Returns the annotation block for index, or NULL if there is no such block.
- virtual const IAnnotation_block* mi::neuraylib::IAnnotation_list::get_annotation_block( const char* name) const [pure virtual]
-
Returns the annotation block for name, or NULL if there is no such block.
- 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.
- virtual const char* mi::neuraylib::IAnnotation_list::get_name( Size index) const [pure virtual]
-
Returns the name for the given index, or NULL if there is no such block.
- virtual Size mi::neuraylib::IAnnotation_list::get_size() const [pure virtual]
-
Returns the number of elements.
- 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 (NULL pointer).
- -2: index is out of bounds.
- 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 (NULL pointer).
- -2: There is no annotation block mapped to name in the list.