---

AGAPI.h File Reference

#include <string>
#include <list>
#include <set>
#include <map>
#include "AGTypes.h"

Include dependency graph for AGAPI.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	DllExport
Functions
DllExport AGSetId	CreateAGSet (AGSetId id)
DllExport bool	ExistsAGSet (AGSetId id)
DllExport void	DeleteAGSet (AGSetId id)
DllExport AGId	CreateAG (Id id, TimelineId timelineId)
DllExport bool	ExistsAG (AGId agId)
DllExport void	DeleteAG (AGId agId)
DllExport AGIds	GetAGIds (AGSetId agSetId)
DllExport TimelineId	CreateTimeline (Id id)
DllExport bool	ExistsTimeline (TimelineId timelineId)
DllExport void	DeleteTimeline (TimelineId timelineId)
DllExport SignalId	CreateSignal (Id id, URI uri, MimeClass mimeClass, MimeType mimeType, Encoding encoding, Unit unit, Track track)
DllExport bool	ExistsSignal (SignalId signalId)
DllExport void	DeleteSignal (SignalId signalId)
DllExport SignalIds	GetSignals (TimelineId timelineId)
DllExport MimeClass	GetSignalMimeClass (SignalId signalId)
DllExport MimeType	GetSignalMimeType (SignalId signalId)
DllExport Encoding	GetSignalEncoding (SignalId signalId)
DllExport string	GetSignalXlinkType (SignalId signalId)
DllExport string	GetSignalXlinkHref (SignalId signalId)
DllExport string	GetSignalUnit (SignalId signalId)
DllExport Track	GetSignalTrack (SignalId signalId)
DllExport AnnotationId	CreateAnnotation (Id id, AnchorId anchorId1, AnchorId anchorId2, AnnotationType annotationType)
DllExport bool	ExistsAnnotation (AnnotationId annotationId)
DllExport void	DeleteAnnotation (AnnotationId annotationId)
DllExport AnnotationId	CopyAnnotation (AnnotationId annotationId)
DllExport AnnotationIds	SplitAnnotation (AnnotationId annotationId)
DllExport AnnotationIds	NSplitAnnotation (AnnotationId annotationId, short N)
DllExport AnnotationType	GetAnnotationType (AnnotationId annotationId)
DllExport String	GetAnnotationInfo (AnnotationId annotationId)
DllExport AnchorId	GetStartAnchor (AnnotationId annotationId)
DllExport AnchorId	GetEndAnchor (AnnotationId annotationId)
DllExport void	SetStartAnchor (AnnotationId annotationId, AnchorId anchorId)
DllExport void	SetEndAnchor (AnnotationId annotationId, AnchorId anchorId)
DllExport Offset	GetStartOffset (AnnotationId annotationId)
DllExport Offset	GetEndOffset (AnnotationId annotationId)
DllExport void	SetStartOffset (AnnotationId annotationId, Offset offset)
DllExport void	SetEndOffset (AnnotationId annotationId, Offset offset)
DllExport set<AnnotationType>	GetAnnotationTypes (Id id)
DllExport set<FeatureName>	GetAnnotationFeatureNames (Id id)
DllExport AnnotationRef	GetRef (Id id)
DllExport void	SetFeature (Id id, FeatureName featureName, FeatureValue featureValue)
DllExport bool	ExistsFeature (Id id, FeatureName featureName)
DllExport void	DeleteFeature (Id id, FeatureName featureName)
DllExport string	GetFeature (Id id, FeatureName featureName)
DllExport void	UnsetFeature (Id id, FeatureName featureName)
DllExport FeatureNames	GetFeatureNames (Id id)
DllExport void	SetFeatures (Id id, Features features)
DllExport Features	GetFeatures (Id id)
DllExport void	UnsetFeatures (Id id)
DllExport AnchorId	CreateAnchor (Id id, Offset offset, Unit unit, SignalIds signalIds)
DllExport AnchorId	CreateAnchor (Id id, SignalIds signalIds="")
DllExport bool	ExistsAnchor (AnchorId anchorId)
DllExport void	DeleteAnchor (AnchorId anchorId)
DllExport void	SetAnchorOffset (AnchorId anchorId, Offset offset)
DllExport Offset	GetAnchorOffset (AnchorId anchorId)
DllExport void	SetOffsetUnit (AnchorId anchorId, Unit unit)
DllExport Unit	GetOffsetUnit (AnchorId anchorId)
DllExport void	SetAnchorSignalIds (AnchorId anchorId, SignalIds signalIds)
DllExport SignalIds	GetAnchorSignalIds (AnchorId anchorId)
DllExport bool	GetAnchored (AnchorId anchorId)
DllExport void	UnsetAnchorOffset (AnchorId anchorId)
DllExport AnchorId	SplitAnchor (AnchorId anchorId)
DllExport AnnotationIds	GetIncomingAnnotationSet (AnchorId anchorId)
DllExport AnnotationIds	GetOutgoingAnnotationSet (AnchorId anchorId)
DllExport AnnotationIds	GetIncomingAnnotationSetByType (AnchorId anchorId, AnnotationType type)
DllExport AnnotationIds	GetOutgoingAnnotationSetByType (AnchorId anchorId, AnnotationType type)
DllExport AnchorIds	GetAnchorSet (AGId agId)
DllExport AnchorIds	GetAnchorSetByOffset (AGId agId, Offset offset, double epsilon=0.0)
DllExport AnchorIds	GetAnchorSetNearestOffset (AGId agId, Offset offset)
DllExport AnnotationIds	GetAnnotationSetByFeature (AGId agId, FeatureName featureName, FeatureValue featureValue)
DllExport AnnotationIds	GetAnnotationSetByOffset (AGId agId, Offset offset)
DllExport AnnotationIds	GetAnnotationSetByType (AGId agId, AnnotationType annotationType)
DllExport AnnotationIds	GetAnnotationSeqByOffset (AGId agId, Offset begin=0.0, Offset end=0.0)
DllExport AnnotationId	GetAnnotationByOffset (AGId agId, Offset offset)
DllExport AGSetId	GetAGSetId (Id id="")
DllExport AGId	GetAGId (Id id)
DllExport TimelineId	GetTimelineId (Id id)
DllExport string	toXML (Id id)
DllExport bool	LoadFromDB (string connStr, AGSetId agsetId)
DllExport bool	StoreToDB (string connStr, AGSetId agSetId)
DllExport list<string>	StoreSQLs (AGSetId agSetId)
DllExport bool	SPrecedes (const AnnotationId &x, const AnnotationId &y)
DllExport AGIds	Load (const string &format, const string &annotationFile, const string &id="", map< string, string > *signalInfo=NULL, map< string, string > *options=NULL)
DllExport void	Store (const string &format, const string &filename, const string &agIds="", map< string, string > *options=NULL)
DllExport bool	CheckAnchorOffsetTotal (Id agId, AnnotationType type)
DllExport bool	CheckAnchorOffsetBounded (Id agId, AnnotationType type)
DllExport bool	CheckFeatureExists (Id agId, AnnotationType type, FeatureName featureName)
DllExport bool	CheckFeatureIsAnnotationId (Id agId, AnnotationType type, FeatureName featureName)
DllExport bool	CheckLinear (Id agId, AnnotationType type)
DllExport bool	CheckConnected (Id agId, AnnotationType type)
DllExport bool	CheckCoextensive (Id agId, AnnotationType type1, AnnotationType type2)
DllExport bool	CheckSpan (Id agId, AnnotationType spanType, AnnotationType spannedType)

---

Define Documentation

#define DllExport

Value:

---

Function Documentation

DllExport bool CheckAnchorOffsetBounded ( Id agId, AnnotationType type )

DllExport bool CheckAnchorOffsetTotal ( Id agId, AnnotationType type )

DllExport bool CheckCoextensive ( Id agId, AnnotationType type1, AnnotationType type2 )

DllExport bool CheckConnected ( Id agId, AnnotationType type )

DllExport bool CheckFeatureExists ( Id agId, AnnotationType type, FeatureName featureName )

DllExport bool CheckFeatureIsAnnotationId ( Id agId, AnnotationType type, FeatureName featureName )

DllExport bool CheckLinear ( Id agId, AnnotationType type )

DllExport bool CheckSpan ( Id agId, AnnotationType spanType, AnnotationType spannedType )

DllExport AnnotationId CopyAnnotation ( AnnotationId annotationId )

DllExport AGId CreateAG ( Id id, TimelineId timelineId )

DllExport AGSetId CreateAGSet ( AGSetId id )

DllExport AnchorId CreateAnchor ( Id id, SignalIds signalIds = "" )

DllExport AnchorId CreateAnchor ( Id id, Offset offset, Unit unit, SignalIds signalIds )

DllExport AnnotationId CreateAnnotation ( Id id, AnchorId anchorId1, AnchorId anchorId2, AnnotationType annotationType )

DllExport SignalId CreateSignal ( Id id, URI uri, MimeClass mimeClass, MimeType mimeType, Encoding encoding, Unit unit, Track track )

DllExport TimelineId CreateTimeline ( Id id )

DllExport void DeleteAG ( AGId agId )

DllExport void DeleteAGSet ( AGSetId id )

DllExport void DeleteAnchor ( AnchorId anchorId )

DllExport void DeleteAnnotation ( AnnotationId annotationId )

DllExport void DeleteFeature ( Id id, FeatureName featureName )

DllExport void DeleteSignal ( SignalId signalId )

DllExport void DeleteTimeline ( TimelineId timelineId )

DllExport bool ExistsAG ( AGId agId )

DllExport bool ExistsAGSet ( AGSetId id )

DllExport bool ExistsAnchor ( AnchorId anchorId )

DllExport bool ExistsAnnotation ( AnnotationId annotationId )

DllExport bool ExistsFeature ( Id id, FeatureName featureName )

DllExport bool ExistsSignal ( SignalId signalId )

DllExport bool ExistsTimeline ( TimelineId timelineId )

DllExport AGId GetAGId ( Id id )

DllExport AGIds GetAGIds ( AGSetId agSetId )

DllExport AGSetId GetAGSetId ( Id id = "" )

DllExport Offset GetAnchorOffset ( AnchorId anchorId )

DllExport AnchorIds GetAnchorSet ( AGId agId )

DllExport AnchorIds GetAnchorSetByOffset ( AGId agId, Offset offset, double epsilon = 0.0 )

DllExport AnchorIds GetAnchorSetNearestOffset ( AGId agId, Offset offset )

DllExport SignalIds GetAnchorSignalIds ( AnchorId anchorId )

DllExport bool GetAnchored ( AnchorId anchorId )

DllExport AnnotationId GetAnnotationByOffset ( AGId agId, Offset offset )

DllExport set< FeatureName > GetAnnotationFeatureNames<FeatureName> ( Id id )

DllExport String GetAnnotationInfo ( AnnotationId annotationId )

DllExport AnnotationIds GetAnnotationSeqByOffset ( AGId agId, Offset begin = 0.0, Offset end = 0.0 )

DllExport AnnotationIds GetAnnotationSetByFeature ( AGId agId, FeatureName featureName, FeatureValue featureValue )

DllExport AnnotationIds GetAnnotationSetByOffset ( AGId agId, Offset offset )

Get all annotations with its start anchor offset in between the specified values. Get all annotations with its start anchor offset in between the specified values. If both values are 0, return all annotations in the AG. Parameters: begin, the   lower bound, default is 0.0. end, the   upper bound, default is 0.0. Returns: all qualified annotations, sorted by start anchor offset.

DllExport AnnotationIds GetAnnotationSetByType ( AGId agId, AnnotationType annotationType )

DllExport AnnotationType GetAnnotationType ( AnnotationId annotationId )

DllExport set< AnnotationType > GetAnnotationTypes<AnnotationType> ( Id id )

DllExport AnchorId GetEndAnchor ( AnnotationId annotationId )

DllExport Offset GetEndOffset ( AnnotationId annotationId )

DllExport string GetFeature ( Id id, FeatureName featureName )

DllExport FeatureNames GetFeatureNames ( Id id )

DllExport Features GetFeatures ( Id id )

DllExport AnnotationIds GetIncomingAnnotationSet ( AnchorId anchorId )

DllExport AnnotationIds GetIncomingAnnotationSetByType ( AnchorId anchorId, AnnotationType type )

DllExport Unit GetOffsetUnit ( AnchorId anchorId )

DllExport AnnotationIds GetOutgoingAnnotationSet ( AnchorId anchorId )

DllExport AnnotationIds GetOutgoingAnnotationSetByType ( AnchorId anchorId, AnnotationType type )

DllExport AnnotationRef GetRef ( Id id )

DllExport Encoding GetSignalEncoding ( SignalId signalId )

DllExport MimeClass GetSignalMimeClass ( SignalId signalId )

DllExport MimeType GetSignalMimeType ( SignalId signalId )

DllExport Track GetSignalTrack ( SignalId signalId )

DllExport string GetSignalUnit ( SignalId signalId )

DllExport string GetSignalXlinkHref ( SignalId signalId )

DllExport string GetSignalXlinkType ( SignalId signalId )

DllExport SignalIds GetSignals ( TimelineId timelineId )

DllExport AnchorId GetStartAnchor ( AnnotationId annotationId )

DllExport Offset GetStartOffset ( AnnotationId annotationId )

DllExport TimelineId GetTimelineId ( Id id )

DllExport AGIds Load ( const string & format, const string & annotationFile, const string & id = "", map< string, string > * signalInfo = NULL, map< string, string > * options = NULL )

DllExport bool LoadFromDB ( string connStr, AGSetId agsetId )

DllExport AnnotationIds NSplitAnnotation ( AnnotationId annotationId, short N )

DllExport bool SPrecedes ( const AnnotationId & x, const AnnotationId & y )

DllExport void SetAnchorOffset ( AnchorId anchorId, Offset offset )

DllExport void SetAnchorSignalIds ( AnchorId anchorId, SignalIds signalIds )

DllExport void SetEndAnchor ( AnnotationId annotationId, AnchorId anchorId )

DllExport void SetEndOffset ( AnnotationId annotationId, Offset offset )

DllExport void SetFeature ( Id id, FeatureName featureName, FeatureValue featureValue )

DllExport void SetFeatures ( Id id, Features features )

DllExport void SetOffsetUnit ( AnchorId anchorId, Unit unit )

DllExport void SetStartAnchor ( AnnotationId annotationId, AnchorId anchorId )

DllExport void SetStartOffset ( AnnotationId annotationId, Offset offset )

DllExport AnchorId SplitAnchor ( AnchorId anchorId )

DllExport AnnotationIds SplitAnnotation ( AnnotationId annotationId )

DllExport void Store ( const string & format, const string & filename, const string & agIds = "", map< string, string > * options = NULL )

DllExport list< string > StoreSQLs<string> ( AGSetId agSetId )

DllExport bool StoreToDB ( string connStr, AGSetId agSetId )

DllExport void UnsetAnchorOffset ( AnchorId anchorId )

DllExport void UnsetFeature ( Id id, FeatureName featureName )

DllExport void UnsetFeatures ( Id id )

DllExport string toXML ( Id id )

---