The Phones Module - Tcl

This page contains the explanations, usage, and syntax of the methods and the configurable parameters for the Phones and PhonesSet object classes.

Phones Methods

<object> puts
List all the names of the of the monophones that are in the Phones object. The output is sorted alphabetically. At the same time, the monophones are sorted by their indices. Just entering the name of the object has the same behaviour as calling the puts method.
<object> read <filename>
Read monophone names from the named file. The monophones in the file are added to the monophones that are already in the given object. The 'old' monophones are not removed.
<object> write <filename>
Expects one argument, the name of the file into which it should write the names of the monophones in the given object.
<object> add <name*>
Expects any number of monophone names which will be added to the ones that are already in the Phones object. If a monophone name already exists, then it will not be doubled, and no warning or error message will be produced. Every monophone can only occur once in one Phones object.
<object> delete <name*>
Expects any number of monophone names which will be removed from the Phones object. If a monophone is tried to be removed twice or if it does not exist in the object then an error message will be issued. Please keep in mind, that deleting a monophone whose index is n does change the indices of the monophones with index m>n. Adding and deleting monophones should be finished before a monophone object is given to any other object for indexing.
<object> index <name*>
Expects any number of monophone names. The method will return the list of indices of the named monophones (as they would be in any module which uses the object for indexing).
<object> name <index*>
Expects any number of integers and returns the names of the monophones whose index they represent. If an index is less than zero or greater than the greatest index in the object the resulting name will be (null). Please keep in mind, that deleting monophones from an object can change the indices of other objects.

PhonesSet Methods

<object> puts
List all the names of the of the Phones objects that are a subobject of the PhonesSet object. The result is not sorted alphabetically but by the indices of the Phones objects. Entering only the name of the PhonesSet has the same behaviour as the puts method.
<object> read <filename>
Expects the name of the file from which it should read the Phones definitions that will be added to the Phones definitions already residing in the PhonesSet object. If there is a Phones definition with the same name as one that is already in the object, then the one from the file will be ignored.
<object> write <filename>
Expects the name of the file into which it will write the objects definitions.
<object> add <name> <phone*>
Expects the name of a Phones subobject followed by any number of monophone names. This definition will be added to the already existing definitions, unless an Phones subobject with the same name is already existing. In the latter case, the add method will be ignored. If you want to modify a definition then you'll have to first delete it and then add a completely new one.
<object> delete <name*>
Expects any number of Phones subobject names which will be deleted from the given object. If you try to delete a non existing subobject, then an error message will be issued. Keep in mind, that removing subobjects can change the indices of the other subobjects (same as with deleting a monophone from a Phones object. However, there is no reasonable application that uses the Phones subobjects' indices.
<object> index <name*>
Expects any number of Phones subobject names. The method will return the list of indices of the named subobjects.
name <index*>
Expects any number of integers and returns the names of the Phones subobjects whose index they represent. If an index is less than zero or greater than the greatest index in the object the resulting name will be (null). Please keep in mind, that deleting subobjects from an object can change the indices of other objects.

Accessing Subobjects

If you know the name of a Phones subobject of a PhonesSet object, then you can access the subobject with the term <PhonesSetName>:<PhonesName>. If you don't know the name, but you know the index, then you can access the subobject with the term <PhonesSetName>.item(<PhonesIndex>).

Configurable Parameters

Both the Phones and PhonesSet classes have the same configurable parameters, which are:

-useN <integer>
is the count of super-objects that are using the cofigured object.
-itemN <integer>
is the number of items in the configured object, i.e. the number of monophones in a Phones object or the number of Phones objects in a PhonesSet object.
-blkSize <integer>
is the blocksize of the used generic list.
-commentChar <character>
If (while reading a file) this character is the first character of a line, then that line will be ignored. When writing a file this character will be used to initiate a comment header.