Class Specialization
AnnotationTree Iterator
Iterator of the annotation tree represented by a FragmentStore.
| |||||||||||||||||||||||
![]() | ![]() | ||||||||||||||||||||||
AnnotationTree Iterator | |||||||||||||||||||||||
Include Headers
seqan/store.h
Parameters
A FragmentStore class. Types: FragmentStore |
Remarks
This iterator can move down, right, and up in the tree and supports a preorder dfs traversal via the functions goBegin, goNext, and atEnd.
Preorder means that the iterator visits a node before its children.
To access the annotation, the iterator points to, use getAnnotation. The annotation id is returned by value.
Specialization of
Metafunctions
| Type of the container given an iterator. (Iter) | |
| Type of an object that stores the difference between two iterators. (Iter) | |
| Type for reading values. (Iter) | |
| Type of iterator objects that are used to traverse the container. (Iter) | |
| Type of an object that represents a position in a container. (Iter) | |
| Reference type. (Iter) | |
| The spec of a class. (Iter) | |
| Type of the items in the container or behind an iterator. (Iter) |
Member Functions
| Constructor |
Functions
| Assigns value to item. (Iter) | |
| Add or update a key-value pair of the current annotation. | |
| Determines whether an iterator is at the beginning position. | |
| Determines whether an iterator is at the end position. | |
| Returns true if the iterator is at the end of a sequence. (Iter) | |
| Clear all key-value pairs of the current annotation. | |
| Container of an iterator. (Iter) | |
| Creates a new left-most child of the current node and returns an iterator to it. | |
| Creates a new right-most child of the current node and returns an iterator to it. | |
| Creates a new right sibling of the current node and returns an iterator to it. | |
| The difference between two iterators. (Iter) | |
| Returns the current annotation. | |
| Returns the identifier of the current annotation. | |
| Returns the identifier of the parent node in the annotation tree of the current annotation. | |
| Returns the type name of the current annotation. | |
| Returns a unique name of the current annotation. | |
| Access to the value. (Iter) | |
| Given a key, retrieve its value of the current annotation. | |
| Iterates to the first position of a container. | |
| Move the iterator down to the left-most child in the annotation tree. | |
| Iterates to the last position of a container. | |
| Iterates some steps further. (Iter) | |
| Iterates to next position. | |
| Go to the next node in preorder DFS skipping the current node's subtree. | |
| Go to the next node in preorder DFS skipping the subtrees of the current node and of all its siblings. | |
| Iterates to pevious position. (Iter) | |
| Move the iterator right to the next sibling in the annotation tree. | |
| Go to the root node in the annotation tree. | |
| Moves the iterator to an arbitrary node given its annotationId. | |
| Move the iterator up in the annotation tree. | |
| Returns a boolean value that indicates whether the current node is the last child. | |
| Test whether a tree iterator points to a leaf. | |
| Test whether a tree iterator points to the root node. | |
| Assigns value to item. (Iter) | |
| Returns a new iterator to the first child node of the current annotation in the annotation tree. | |
| Returns a new iterator to the right sibling of the current annotation in the annotation tree. | |
| Returns a new iterator to the parent node of the current annotation in the annotation tree. | |
| Position of an iterator. (Iter) | |
| Sets the identifier of the current annotation. | |
| Sets the type name of the current annotation. | |
| Reference to the value. (Iter) |
Examples
![]() |
| Typical annotation tree hierarchy. |
A new annotation tree iterator can be instantiated as follows:
it = begin(store, AnnotationTree<>());
Or shorter (see AnnotationTree Iterator constructor):
SeqAn - Sequence Analysis Library - www.seqan.de

