#include <include/ling_class/EST_Item.h>

Public Member Functions
EST_Item_Content *	contents () const

void	set_contents (EST_Item_Content *li)

const EST_String	name () const

void	set_name (const EST_String &name) const

EST_Features &	features () const

const EST_Val	f (const EST_String &name) const

const EST_Val	f (const EST_String &name, const EST_Val &def) const

EST_Item *	next () const

EST_Item *	prev () const

EST_Item *	down () const

EST_Item *	up () const

EST_Item *	last () const

EST_Item *	first () const

EST_Item *	top () const

EST_Item *	bottom () const

EST_Item *	first_leaf () const

EST_Item *	next_leaf () const

EST_Item *	last_leaf () const

EST_Item *	next_item () const

EST_Item *	insert_after (EST_Item *li=0)

EST_Item *	insert_before (EST_Item *li=0)

EST_Item *	insert_below (EST_Item *li=0)

EST_Item *	insert_above (EST_Item *li=0)

EST_Item *	append_daughter (EST_Item *li=0)

EST_Item *	prepend_daughter (EST_Item *li=0)

EST_Item *	insert_parent (EST_Item *li=0)

void	unref_all ()

int	verify () const

EST_Item &	operator= (const EST_Item &s)

Constructor Functions
	EST_Item ()
	Default constructor.

	EST_Item (const EST_Item &item)
	Copy constructor only makes reference to contents.

	EST_Item (EST_Relation *rel)
	Includes reference to relation.

	EST_Item (EST_Relation rel, EST_Item si)
	Most common form of construction.

	~EST_Item ()
	Deletes it and references to it in its contents.

Feature access functions.
These functions are wrap-around functions to the basic access functions in the {EST_Features} class. In all these functions, if the optional argument <parameter>m} is set to 1, an error is thrown if the feature does not exist
const float	F (const EST_String &name) const

const float	F (const EST_String &name, float def) const

const EST_String	S (const EST_String &name) const

const EST_String	S (const EST_String &name, const EST_String &def) const

const int	I (const EST_String &name) const

const int	I (const EST_String &name, int def) const

EST_Features &	A (const EST_String &name) const

EST_Features &	A (const EST_String &name, EST_Features &def) const

Feature setting functions.
A separate function is provided for each permissible value type
void	set (const EST_String &name, int ival)

void	set (const EST_String &name, float fval)

void	set (const EST_String &name, double fval)

void	set (const EST_String &name, const EST_String &sval)

void	set (const EST_String &name, const char *cval)

void	set_function (const EST_String &name, const EST_String &funcname)

void	set (const EST_String &name, EST_Features &f)

void	set_val (const EST_String &name, const EST_Val &sval)

Utility feature functions
void	f_remove (const EST_String &name)

void	evaluate_features ()

int	f_present (const EST_String &name) const

int	length () const

Cross relational access
EST_Item *	as_relation (const char *relname) const
	View item from another relation (const char *) method.

int	in_relation (const EST_String &relname) const
	TRUE if this item is in named relation.

EST_TKVL< EST_String, EST_Val > &	relations ()
	Access to the relation links.

const EST_String &	relation_name () const
	The relation name of this particular item.

EST_Relation *	relation (void) const
	The relation of this particular item.

int	same_item (const EST_Item *li) const
	True if li is the same item ignoring its relation viewpoint.

Static Public Member Functions
static void	splice (EST_Item a, EST_Item b)

Static Protected Member Functions
static void	class_init (void)

Friends
class	EST_Relation

class	ling_class_init

int	i_same_item (const EST_Item l1, const EST_Item l2)

int	move_item (EST_Item from, EST_Item to)

int	merge_item (EST_Item from, EST_Item to)

int	move_sub_tree (EST_Item from, EST_Item to)

int	exchange_sub_trees (EST_Item from, EST_Item to)

ostream &	operator<< (ostream &s, const EST_Item &a)

bool	operator!= (const EST_Item &a, const EST_Item &b)

bool	operator== (const EST_Item &a, const EST_Item &b)

Detailed Description

A class for containing individual linguistic objects such as

words or phones.

These contain two types of information. This first is specific to the {EST_Relation} we are viewing this ling item from, the second part consists of a set of features. These features may be shared by instances of this ling item in different <link linkend="est-relation">EST_Relation</link> within the same <link linkend="est-utterance">EST_Utterances</link>

The shared part of an <link linkend="est-item">EST_Item</link> is represented by the class EST_Item_Content. It should not normally be accessed by the general users as reverse links from the contents to each of the EST_Items it is part of are held ensure the integrity of the structures. Changing these without maintain the appropriate links is unlikely to be stable.

We believe this structure is the most efficient for the most natural use we envisage. Traversal of the items ....

Definition at line 82 of file EST_Item.h.

Member Function Documentation

const float EST_Item::F ( const EST_String & name ) const

inline

return the value of the feature <parameter>name</parameter>

cast as a float

Definition at line 134 of file EST_Item.h.

const float EST_Item::F	(	const EST_String &	name,
		float	def
	)		const

inline

return the value of the feature <parameter>name</parameter> cast

as a float, returning <parameter>def</parameter> if not found.

Definition at line 138 of file EST_Item.h.

const EST_String EST_Item::S ( const EST_String & name ) const

inline

return the value of the feature <parameter>name</parameter>

cast as a EST_String

Definition at line 143 of file EST_Item.h.

const EST_String EST_Item::S	(	const EST_String &	name,
		const EST_String &	def
	)		const

inline

return the value of the feature <parameter>name</parameter>

cast as a EST_String, returning <parameter>def</parameter> if not found.

Definition at line 149 of file EST_Item.h.

const int EST_Item::I ( const EST_String & name ) const

inline

return the value of the feature <parameter>name</parameter>

cast as a int

Definition at line 154 of file EST_Item.h.

const int EST_Item::I	(	const EST_String &	name,
		int	def
	)		const

inline

return the value of the feature <parameter>name</parameter> cast as a int

returning <parameter>def</parameter> if not found.

Definition at line 158 of file EST_Item.h.

EST_Features& EST_Item::A ( const EST_String & name ) const

inline

return the value of the feature <parameter>name</parameter>

cast as a EST_Features

Definition at line 163 of file EST_Item.h.

EST_Features& EST_Item::A	(	const EST_String &	name,
		EST_Features &	def
	)		const

inline

return the value of the feature <parameter>name</parameter>

cast as a EST_Features, returning <parameter>def</parameter> if not found.

Definition at line 169 of file EST_Item.h.

void EST_Item::set	(	const EST_String &	name,
		int	ival
	)

inline