#include <OCDM.h>
Inheritance diagram for OCDM_AnnotationSet:
Public Member Functions | |
OCDM_AnnotationSet () | |
OCDM_AnnotationSet (const CDM_Object obj) | |
OCDM_AnnotationSet (const class OCDM_AnnotationSet &obj) | |
OCDM_AnnotationSet & | operator= (const class OCDM_Object &obj) |
This is the default assignment operator. | |
OCDM_INDEX_OPERATOR_REF (OCDM_Annotation) operator[](const long index) const | |
void | AddAnnotation (const OCDM_Annotation &Ann) |
This function will add the given Annotation (specified by the "Ann" parameter) into the Annotation set object in use. | |
int | CompareAnnotations (const OCDM_Annotation &Ann1, const OCDM_Annotation &Ann2) const |
This function will compare two Annotations, Ann1 and Ann2, according to their Span sets. | |
void | MergeAnnotations (OCDM_AnnotationSet &AnnSet) |
The goal of this function is to concatenate the Annotation set object in use with the object having being defined in the parameter AnnSet. | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsAt(const long position) const | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsContaining(const long position) const | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsContaining(const long position1 | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsInRange(const long Start | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsInRange(const OCDM_Annotation &Ann) const | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsMatchingRange(long Start | |
OCDM_REF (OCDM_AnnotationSet) AnnotationsMatchingRange(const OCDM_Annotation &Ann) const | |
OCDM_REF (OCDM_Annotation) FirstAnnotationContaining(const long Position) const | |
OCDM_REF (OCDM_Annotation) FirstAnnotationContaining(const long Position1 | |
OCDM_REF (OCDM_Annotation) GetAnnotation(const long Id) const | |
void | RemoveAnnotation (const long Id) |
This function will remove the Annotation object that has as Id the value specified by the "Id" parameter from the Annotation set object we are currently use. | |
OCDM_REF (OCDM_AnnotationSet) SelectAnnotations(const char *Type) const | |
OCDM_REF (OCDM_AnnotationSet) SelectAnnotations(const char *Type | |
OCDM_REF (OCDM_AnnotationSet) SelectAnnotationsSorted(const char *Type) const | |
OCDM_REF (OCDM_AnnotationSet) SelectAnnotationsSorted(const char *Type | |
void | SortAnnotationSet (void) |
This function will sort all the annotations, contained in the Annotation Set object in use, according to their span ranges. | |
void | DisplaceAnnotations (const long offset, const long displacement) |
This function displases or "moves" the Annotations of the Annotation set object in use by "displacement" characters. | |
OCDM_REF (OCDM_AnnotationSet) NextAnnotations(const long Position) const | |
const char * | objectType (void) const |
Public Attributes | |
const long position2 | const |
const long End | const |
long End | const |
const long Position2 | const |
const char *Constraints | const |
const char *Constraints | const |
OCDM_AnnotationSet | ( | const CDM_Object | obj | ) |
OCDM_AnnotationSet | ( | const class OCDM_AnnotationSet & | obj | ) |
class OCDM_AnnotationSet& operator= | ( | const class OCDM_Object & | obj | ) | [virtual] |
obj:
the object to be copied. Reimplemented from OCDM_Object.
OCDM_INDEX_OPERATOR_REF | ( | OCDM_Annotation | ) | const |
void AddAnnotation | ( | const OCDM_Annotation & | Ann | ) |
Ann:
The name of the annotation to be added. int CompareAnnotations | ( | const OCDM_Annotation & | Ann1, | |
const OCDM_Annotation & | Ann2 | |||
) | const |
Ann1:
The first annotation to be compared. Ann2:
The second annotation to be compared according to their span setvoid MergeAnnotations | ( | OCDM_AnnotationSet & | AnnSet | ) |
AnnSet:
The name of the annotation to be concatenated. OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_Annotation | ) | const |
OCDM_REF | ( | OCDM_Annotation | ) | const |
OCDM_REF | ( | OCDM_Annotation | ) | const |
void RemoveAnnotation | ( | const long | Id | ) |
Id:
The id of the annotation to be removedOCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
void SortAnnotationSet | ( | void | ) |
For more information about the sorting order, please refer to the CompareAnnotations function.
In case of an error, an Exception of type OCDM_Exception will be thrown
OCDM_REF | ( | OCDM_AnnotationSet | ) | const |
const char* objectType | ( | void | ) | const [virtual] |
This method returns the type of the object as a string.
Reimplemented from OCDM_Object.
long End const |