#include <include/EST_TrackMap.h>

Inheritance diagram for EST_TrackMap:

Collaboration diagram for EST_TrackMap:

Classes
struct	ChannelMappingElement
	structure for the table. More...

Public Types
typedef EST_THandle< EST_TrackMap, EST_TrackMap >	P
	Table of type to position pairs. More...

Public Member Functions
	EST_TrackMap (void)
	Default constructor. More...

	EST_TrackMap (EST_TrackMap &from, int refcount)
	Copy the mapping. More...

	EST_TrackMap (struct ChannelMappingElement map[])
	Create from static table. More...

	~EST_TrackMap ()

void	clear (void)
	Empty the map. More...

void	set (EST_ChannelType type, short pos)
	Record the position of a channel. More...

short	get (EST_ChannelType type) const
	Get the position of a channel. More...

short	operator() (EST_ChannelType type) const
	Get the position of a channel. More...

bool	has_channel (EST_ChannelType type) const
	Does the mapping contain a position for this channel? More...

short	last_channel (void) const
	Returns the index of the last known channel. More...

EST_ChannelType	channel_type (unsigned short channel) const
	Returns the type of the channel at the given position. More...

EST_TrackMap *	object_ptr ()

const EST_TrackMap *	object_ptr () const

Public Member Functions inherited from EST_Handleable
	EST_Handleable (void)

int	refcount (void) const

void	start_refcounting (int initial=0)

void	inc_refcount (void)

void	dec_refcount (void)

int	is_unreferenced (void) const

int	is_refcounted (void) const

Protected Member Functions
	EST_TrackMap (int refcount)
	Creation function used by friends to create refcounted maps. More...

	EST_TrackMap (const EST_TrackMap *parent, int offset, int refcount)
	Creation function used by friends to create sub-track maps. More...

void	copy (EST_TrackMap &from)
	copy an exiting map. More...

void	init (void)
	Initialise the map. More...

short	get_parent (EST_ChannelType type) const

Friends
class	EST_Track

std::ostream &	operator<< (std::ostream &st, const EST_TrackMap &m)

Detailed Description

Track maps provide a mapping from symbolic track names to the actual position of the information within a track frame. The symbolic names are defined by the EST_ChannelType enumerated type.

Track maps can be declared statically by code which always uses tracks of a given style, or they can be built at run time as is done by lpc_analysis to record whichinformation the user has requested. Finally they can be constructed by the Track itself from the names of the channels, for instance when a track has just been read in from a file.

See also: EST_Track; EST_ChannelType; EST_TrackMap:example

Author: Richard Caley rjc@c.nosp@m.str..nosp@m.ed.ac.nosp@m..uk

Version

Id: EST_TrackMap.h,v 1.4 2004/09/29 08:24:17 robert Exp

Definition at line 61 of file EST_TrackMap.h.

Member Typedef Documentation

typedef EST_THandle<EST_TrackMap,EST_TrackMap> EST_TrackMap::P

Table of type to position pairs.

Definition at line 81 of file EST_TrackMap.h.

Constructor & Destructor Documentation

EST_TrackMap::EST_TrackMap ( int refcount )

protected

Creation function used by friends to create refcounted maps.

Definition at line 73 of file EST_TrackMap.cc.

EST_TrackMap::EST_TrackMap	(	const EST_TrackMap *	parent,
		int	offset,
		int	refcount
	)

protected

Creation function used by friends to create sub-track maps.

Definition at line 80 of file EST_TrackMap.cc.

EST_TrackMap::EST_TrackMap ( void )

Default constructor.

Definition at line 67 of file EST_TrackMap.cc.

EST_TrackMap::EST_TrackMap	(	EST_TrackMap &	from,
		int	refcount
	)

Copy the mapping.

Definition at line 89 of file EST_TrackMap.cc.

EST_TrackMap::EST_TrackMap ( struct ChannelMappingElement map[] )

Create from static table.

Definition at line 97 of file EST_TrackMap.cc.

EST_TrackMap::~EST_TrackMap ( )

Definition at line 106 of file EST_TrackMap.cc.

Member Function Documentation

void EST_TrackMap::copy ( EST_TrackMap & from )

protected

copy an exiting map.

Definition at line 53 of file EST_TrackMap.cc.

void EST_TrackMap::init ( void )

protected

Initialise the map.

Definition at line 60 of file EST_TrackMap.cc.

short EST_TrackMap::get_parent ( EST_ChannelType type ) const

protected

Definition at line 110 of file EST_TrackMap.cc.

void EST_TrackMap::clear ( void )

Empty the map.

Definition at line 47 of file EST_TrackMap.cc.

void EST_TrackMap::set	(	EST_ChannelType	type,
		short	pos
	)

inline

Record the position of a channel.

Definition at line 132 of file EST_TrackMap.h.

short EST_TrackMap::get ( EST_ChannelType type ) const

inline

Get the position of a channel.

Definition at line 136 of file EST_TrackMap.h.

short EST_TrackMap::operator() ( EST_ChannelType type ) const

inline

Get the position of a channel.

Definition at line 140 of file EST_TrackMap.h.

bool EST_TrackMap::has_channel ( EST_ChannelType type ) const

inline

Does the mapping contain a position for this channel?

Definition at line 144 of file EST_TrackMap.h.

short EST_TrackMap::last_channel ( void ) const

Returns the index of the last known channel.

Definition at line 136 of file EST_TrackMap.cc.

EST_ChannelType EST_TrackMap::channel_type ( unsigned short channel ) const

Returns the type of the channel at the given position.

Definition at line 122 of file EST_TrackMap.cc.

EST_TrackMap* EST_TrackMap::object_ptr ( )

inline

Definition at line 154 of file EST_TrackMap.h.

const EST_TrackMap* EST_TrackMap::object_ptr ( ) const

inline

Definition at line 155 of file EST_TrackMap.h.

Friends And Related Function Documentation

friend class EST_Track

friend

Definition at line 157 of file EST_TrackMap.h.

std::ostream& operator<<	(	std::ostream &	st,
		const EST_TrackMap &	m
	)

friend

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

include/EST_TrackMap.h
speech_class/EST_TrackMap.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation