---

Annotation.h

Go to the documentation of this file.

// Annotation.h: An annotation associates symbolic information to a
// region of signal
// Author: Xiaoyi Ma, Steven Bird
// Copyright (C) 2001 Linguistic Data Consortium, U Penn.
// Web: http://www.ldc.upenn.edu/; Email: ldc@ldc.upenn.edu
// For license information, see the file `LICENSE' included
// with the distribution.


#ifndef Annotation_h
#define Annotation_h

#include <string>

#include "AGTypes.h"
#include "Anchor.h"
#include "FeatureMap.h"

using namespace std;

class Annotation {
  friend class AG;
  friend class AnnotationIndex;

 private:
  const Id id;

  String type;

  Anchor* start;

  Anchor* end;

  FeatureMap featureMap;

 protected:
  void setStartAnchor(Anchor* a) { start = a; }

  void setEndAnchor(Anchor* a) { end = a; }

  void setFeature(const FeatureName& feature, const FeatureValue& value);

 public:
  Annotation(Id id, const Annotation*);

  Annotation(Id id, Anchor* start, Anchor* end, String type);

  Id getId() const { return id; }

  Anchor* getStartAnchor() const { return start; }

  Anchor* getEndAnchor() const { return end; }

  String getAnnotationInfo();


  String getType() const { return type; }

  const FeatureMap getFeatureMap() const { return featureMap; }

  FeatureValue getFeature(const FeatureName&) ;

  const char* getFeatureC(const FeatureName&) ;

  bool existsFeature(FeatureName featureName);

  void deleteFeature(FeatureName featureName);
  
  StringSet getFeatureNames();

  Features getFeatures();
  
  void unsetFeatures();

  string toString();

  Annotation operator = (const Annotation&);
  friend bool operator < (const Annotation&, const Annotation&);
  friend bool operator == (const Annotation&, const Annotation&);
};


class AnnotationCompFunc {
 public:
  bool operator() (const Annotation* a1, const Annotation* a2) const {
    Offset a1StartOffset = a1->getStartAnchor()->getOffset();
    Offset a1EndOffset = a1->getEndAnchor()->getOffset();
    Offset a2StartOffset = a2->getStartAnchor()->getOffset();
    Offset a2EndOffset = a2->getEndAnchor()->getOffset();
    
    if (a1StartOffset != a2StartOffset)
      return a1StartOffset < a2StartOffset;
    else if (a1EndOffset != a2EndOffset)
      return a1EndOffset < a2EndOffset;
    else
      return a1->getId() < a2->getId();
  }
};

typedef set<Annotation*,AnnotationCompFunc> AnnotationSeq;
typedef set<Annotation*> AnnotationSet;
#endif

---