mi::neuraylib::IAnnotation_block Class Reference
[MDL type system]
Description
An annotation block is an array of annotations. Annotation blocks can be created with mi::neuraylib::IExpression_factory::create_annotation_block().
Public Member Functions
- virtual Sint32 add_annotation( IAnnotation* annotation) =0
- Adds an annotation at the end of the annotation block. More...
- virtual const IAnnotation* get_annotation( Size index) const =0
- Returns the annotation for index, or NULL if index is out of bounds.
- virtual Size get_size() const =0
- Returns the number of annotations in this block.
- virtual Sint32 set_annotation( Size index, const IAnnotation* annotation) =0
- Sets an annotation block at a given index. More...
Member Functions
- virtual Sint32 mi::neuraylib::IAnnotation_block::add_annotation( IAnnotation* annotation) [pure virtual]
-
Adds an annotation at the end of the annotation block.
Returns
- 0: Success.
- -1: Invalid parameter (NULL pointer).
- virtual const IAnnotation* mi::neuraylib::IAnnotation_block::get_annotation( Size index) const [pure virtual]
-
Returns the annotation for index, or NULL if index is out of bounds.
- virtual Size mi::neuraylib::IAnnotation_block::get_size() const [pure virtual]
-
Returns the number of annotations in this block.
- virtual Sint32 mi::neuraylib::IAnnotation_block::set_annotation( Size index, const IAnnotation* annotation) [pure virtual]
-
Sets an annotation block at a given index.
Returns
- 0: Success.
- -1: Invalid parameter (NULL pointer).
- -2: index is out of bounds.