ScoreProcessing::AnnotationsList Class Reference
[Score Annotations System]
a list of score annotations
More...
#include <AnnotationsList.h>
Public Member Functions | |
| virtual SAnnotationsList | add (SAnnotation a)=0 |
| add an annotation at the end of the list | |
| virtual SAnnotationsList | rem (SAnnotation a)=0 |
| remove an annotation from the list | |
| virtual SAnnotationsList | move (SAnnotation a, TimeRange range)=0 |
| move an annotation included in the list according to the range | |
| virtual SAnnotationsList | clear ()=0 |
| remove all annotations from the list | |
| virtual void | addMeasure (Time shiftFrom, Time measureDuration)=0 |
| shift forward (one measure more) annotations in the list from the Time shiftFrom | |
| virtual void | remMeasure (Time deleteFrom, Time measureDuration)=0 |
| delete the annotations contained in the mesure which deleteFrom is the beginning, and shift backward (one measure less) annotations that come after | |
| virtual int | size ()=0 |
| return the list size | |
| virtual bool | empty ()=0 |
| return true when the list is empty | |
| virtual SAnnotation | get (int index)=0 |
| virtual bool | contains (SAnnotation a)=0 |
| return true if input annotation belongs to the list | |
| virtual SAnnotationsList | insert (SAnnotation a)=0 |
| inserts an annotation at the right place into the list | |
| virtual SAnnotationsList | sort ()=0 |
| sorts the current list | |
| virtual SAnnotationsList | clip (TimeRange tr)=0 |
| returns a sub-list containing all annotations belonging to tr | |
| virtual void | accept (AnnotationBaseVisitor *visitor)=0 |
| pass a visitor to each annotation | |
| virtual std::ostream & | print (std::ostream &out)=0 |
| print the annotations list | |
Protected Member Functions | |
| virtual | ~AnnotationsList () |
Detailed Description
a list of score annotationsImplements a list of score annotations. In this implementation the annotations are now sorted (begin date + priority order). The parse() methods can be used to read an annotation file and add the annotations it contains to the list. They return false in case of syntax error (this need to be tested more). The << operator can be used to print in a parsable format the list of annotation.
Constructor & Destructor Documentation
| virtual ScoreProcessing::AnnotationsList::~AnnotationsList | ( | ) | [inline, protected, virtual] |
Member Function Documentation
| virtual void ScoreProcessing::AnnotationsList::accept | ( | AnnotationBaseVisitor * | visitor | ) | [pure virtual] |
pass a visitor to each annotation
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::add | ( | SAnnotation | a | ) | [pure virtual] |
add an annotation at the end of the list
| virtual void ScoreProcessing::AnnotationsList::addMeasure | ( | Time | shiftFrom, | |
| Time | measureDuration | |||
| ) | [pure virtual] |
shift forward (one measure more) annotations in the list from the Time shiftFrom
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::clear | ( | ) | [pure virtual] |
remove all annotations from the list
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::clip | ( | TimeRange | tr | ) | [pure virtual] |
returns a sub-list containing all annotations belonging to tr
| virtual bool ScoreProcessing::AnnotationsList::contains | ( | SAnnotation | a | ) | [pure virtual] |
return true if input annotation belongs to the list
| virtual bool ScoreProcessing::AnnotationsList::empty | ( | ) | [pure virtual] |
return true when the list is empty
| virtual SAnnotation ScoreProcessing::AnnotationsList::get | ( | int | index | ) | [pure virtual] |
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::insert | ( | SAnnotation | a | ) | [pure virtual] |
inserts an annotation at the right place into the list
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::move | ( | SAnnotation | a, | |
| TimeRange | range | |||
| ) | [pure virtual] |
move an annotation included in the list according to the range
| virtual std::ostream& ScoreProcessing::AnnotationsList::print | ( | std::ostream & | out | ) | [pure virtual] |
print the annotations list
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::rem | ( | SAnnotation | a | ) | [pure virtual] |
remove an annotation from the list
| virtual void ScoreProcessing::AnnotationsList::remMeasure | ( | Time | deleteFrom, | |
| Time | measureDuration | |||
| ) | [pure virtual] |
delete the annotations contained in the mesure which deleteFrom is the beginning, and shift backward (one measure less) annotations that come after
| virtual int ScoreProcessing::AnnotationsList::size | ( | ) | [pure virtual] |
return the list size
| virtual SAnnotationsList ScoreProcessing::AnnotationsList::sort | ( | ) | [pure virtual] |
sorts the current list
The documentation for this class was generated from the following file:
- E:/VEMUS/Vemus/include/ScoreViewer/ScoreProcessing/annotations/AnnotationsList.h
