---

agfio Class Reference

AG file I/O abstract class. More...

#include <agfio.h>

Inheritance diagram for agfio:

[legend]List of all members.

Public Methods
AGIds	load (const string &annotationFile, const string &id="", map< string, string > *signalInfo=NULL, map< string, string > *options=NULL)
	Annotation loader interface. More...
virtual void	store (const string &filename, const AGIds &agIds="", map< string, string > *options=NULL)
	Annotation writer interface. More...
AGSetId	get_agsetid ()
Protected Attributes
string	annotationFile
AGSetId	agsetId
AGIds	agIds
AGId	agId
TimelineId	timelineId
SignalId	signalId
map<string,string>*	signalInfo
map<string,string>*	options

---

Detailed Description

AG file I/O abstract class.

---

Member Function Documentation

AGSetId agfio::get_agsetid ( ) [inline]

AGIds agfio::load ( const string & annotationFile, const string & id = "", map< string, string > * signalInfo = NULL, map< string, string > * options = NULL )

Annotation loader interface. format filename id signalInfo options AIF Yes No No Optional encoding := XML encoding name for the output (default value: UTF-8) BAS Yes Yes Optional No BU Yes (no extension) Yes Optional Optional base := lbl | lba (default value: lbl) LCF Yes Yes Optional No SwitchBoard Yes Yes Optional No TF Yes Yes Optional Yes header := field names separated by separators separator := separator of the format ann_type := type of annotations (default value: TF) TIMIT Yes (no extension) Yes Optional No TreeBank Yes Yes No Optional input type := string (use to load a string instead of a file) XLabel Yes Yes Optional Optional ann_type := type of annotations (default value: object) Parameters: annotationFile   Annotation file name. id   Id of AGSet or AG into which the annotataion will be loaded. signalInfo   Feature-value map for signal information. Possible features include 'uri', 'mimeClass', 'mimeType', 'encoding', 'unit', and 'track'. 'uri' indicates the location of the signal file. options   Feature-value map for extra options. There may be different options in different annotation formats. Returns: Id of the AG(s) where the file is loaded.

void agfio::store ( const string & filename, const AGIds & agIds = "", map< string, string > * options = NULL ) [inline, virtual]

Annotation writer interface. Parameters: filename   The name of the file where the AG's are stored. agIds   Ids of AG's to store. options   Feature-value map of format specific options Reimplemented in LCF, TF, and TreeBank.

---

Member Data Documentation

AGId agfio::agId [protected]

AGIds agfio::agIds [protected]

AGSetId agfio::agsetId [protected]

string agfio::annotationFile [protected]

map< string, string > * agfio::options<string,string> [protected]

SignalId agfio::signalId [protected]

map< string, string > * agfio::signalInfo<string,string> [protected]

TimelineId agfio::timelineId [protected]

---

The documentation for this class was generated from the following file:

• agfio.h

---