SUtteranceClass Structure

speect class SUtteranceClass

The SUtteranceClass structure.

Protected Attributes

SObjectClass _inherit

Inherit from SObjectClass.

const SVoice *(*const voice)(const SUtterance *self, s_erc *error)

Voice function pointer.

Get the voice that the given utterance is associated with.

Parameters:

• self –

  The given utterance.

• error –

  Error code.

Return:

Pointer to the voice.

SRelation *(*const new_relation)(SUtterance *self, const char *name, s_erc *error)

NewRelation function pointer.

Create a new named relation in given utterance. Creates a relation, initializes it (SRelationInit), and sets it in the utterance (SUtteranceClass function pointer set_relation).

Parameters:

• self –

  The given utterance.

• name –

  The new relation’s name.

• error –

  Error code.

Return:

Pointer to newly created relation.

const SRelation *(*const get_relation)(const SUtterance *self, const char *name, s_erc *error)

GetRelation function pointer.

Return the named relation.

Parameters:

• self –

  The given utterance.

• name –

  The name of the relation to return.

• error –

  Error code.

Return:

Pointer to named relation.

void(*const set_relation)(SUtterance *self, SRelation *rel, s_erc *error)

SetRelation function pointer.

Set the named relation in the given utterance.

Parameters:

• self –

  The utterance.

• rel –

  The relation to set in the utterance.

• error –

  Error code.

Note:

The relation must have a name, and will be set in the utterance with this name. If a relation with the same name already exists in the utterance then it will be deleted.

void(*const del_relation)(SUtterance *self, const char *name, s_erc *error)

DelRelation function pointer.

Delete the named relation.

Parameters:

• self –

  The given utterance.

• name –

  The name of the relation to delete.

• error –

  Error code.

s_bool (*const have_relation)(const SUtterance *self, const char *name, s_erc *error)

HaveRelation function pointer.

Query the presence of a named relation.

Parameters:

• self –

  The given utterance.

• name –

  The name of the relation.

• error –

  Error code.

Return:

TRUE if found, else FALSE.

SList *(*const relations_keys)(const SUtterance *self, s_erc *error)

RelationKeys function pointer.

Get the keys of the relations in the given utterance.

Parameters:

• self –

  The given utterance.

• error –

  Error code.

Return:

Pointer to a SList containing the keys of the relations of the utterance. The list objects (keys) are string objects and are accessed with SObjectGetString.

Note:

Caller is responsible for the memory of the returned SList object.