In file ../include/ling_class/EST_Utterance.h:

## class EST_Utterance

> A class that contains <link linkend="est-item">EST_Items</link> and <link linkend="est-relation">EST_Relations</link> between them.

### Public Fields

  | Utterance access

### Public Methods

  | Constructor and initialisation Functions
  | EST_Utterance () default constructor
  | Utility Functions
  void | init () initialise utterance
  void | clear () remove everything in utterance
  void | clear_relations () clear the contents of the relations only
  void | set_highest_id (int n) set the next id to be <parameter>n</parameter>
  int | next_id () return the id of the next item
  | File i/o
  EST_read_status | load (const EST_String &filename) load an utterance from an ascii file
  EST_read_status | load (EST_TokenStream &ts) load an utterance from a already opened token stream
  EST_write_status | save (const EST_String &filename, const EST_String &type="est_ascii") const save an utterance to an ascii file
  EST_write_status | save (ostream &outf, const EST_String &type) const save an utterance to an ostream

## Documentation

> A class that contains <link linkend="est-item">EST_Items</link> and <link linkend="est-relation">EST_Relations</link> between them. Used for holding interrelated linguistic structures.

`Constructor and initialisation Functions`

`EST_Utterance()`
  default constructor

`Utility Functions`

`void init()`
  initialise utterance

`void clear()`
  remove everything in utterance

`void clear_relations()`
  clear the contents of the relations only

`void set_highest_id(int n)`
  set the next id to be <parameter>n</parameter>

`int next_id()`
  return the id of the next item

`File i/o`

`EST_read_status load(const EST_String &filename)`
  load an utterance from an ascii file

`EST_read_status load(EST_TokenStream &ts)`
  load an utterance from a already opened token stream

`EST_write_status save(const EST_String &filename, const EST_String &type="est_ascii") const`
  save an utterance to an ascii file

`EST_write_status save(ostream &outf, const EST_String &type) const`
  save an utterance to an ostream

`Utterance access`
  Utterance access

  `EST_Features f`
    Utterance level features

  `void evaluate_all_features()`
    Evaluarte all feature functions in utterance

  `EST_Features relations`
    The list of named relations

  `int num_relations() const`
    number of relations in this utterance

  `bool relation_present(const EST_String name) const`
    returns true if utterance contains named relations. name can be either a single string or a bracketed list of strings e.g. "(Word Phone Syl)".

  `bool relation_present(EST_StrList &names) const`
    returns true if utterance contains all the relations named in the list name.

  `EST_Relation* relation(const char* name, int err_on_not_found=1)`
    get relation by name

  `EST_Item* id(const EST_String &n)`
    return EST_Item whose id is <parameter>n</parameter>

  `EST_Relation* create_relation(const EST_String &relname)`
    create a new relation called <parameter>n</parameter>

  `void remove_relation(const EST_String &relname)`
    remove the relation called <parameter>n</parameter>

This class has no child classes.

Friends:
  ostream& operator << (ostream &s, const EST_Utterance &u)

Alphabetic index HTML hierarchy of classes or Java

This page is part of the Edinburgh Speech Tools Library documentation
Copyright University of Edinburgh 1997
Contact: speech_tools@cstr.ed.ac.uk