An ordered collection of annotation blocks identified by name or index.
More...
|
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 bool | compare_iid (const Uuid &iid) |
| Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
|
|
An ordered collection of annotation blocks identified by name or index.
Annotation lists can be created with mi::neuraylib::IExpression_factory::create_annotation_list().
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.
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.