Acquiring Annotations
List of: Discussion Topic
Subjects: Feature Naming
Contents: Kernel

After a modeling operation, use the annotation class annotation_ctx to examine a list of the annotations. Annotations are added to the list by the annotation base class constructor and removed by the annotation base class lose method.

There is one session-wide annotation_ctx instance that is accessible through api_get_annotation_ctx. This global context will be used internally by all the annotation APIs, as well as the modeling APIs that are currently annotated. The annotation APIs that normally take a BULLETIN_BOARD parameter will ignore that parameter and will use the annotation list instead.

You can also acquire the list of the generated annotations from the annotation_ctx with api_find_annotations. This creates an entity list that can be handled and queried like any other entity list.

Query functions within ANNOTATION populate an ENTITY_LIST with the inputs or outputs. Each derived ANNOTATION type has more specific query functions for full detail. api_find_annotations permits searching for an annotation of a specific type. So, for example, to get the top vertex annotations from a sweep operation, the is_SWEEP_ANNO_VERTEX_TOP function can be passed as an argument.

Since annotations consume memory and could increase SAT file size, they are usually cleared manually before the next modeling operation, using the api_clear_annotations function.
PDF/KERN/08ANNO.PDF
HTM/DATA/KERN/KERN/08ANNO/0002.HTM