---

Anchor Class Reference

#include <Anchor.h>

List of all members.

Public Methods
	Anchor (Id id, Offset offset, Unit unit, string signals)
	Create an anchor, using the given identifier. More...
	Anchor (Id id, Unit unit, string signals)
	Create an anchor, using a given identifier, but without specifying its offset. More...
	Anchor (Id id, const Anchor *)
	Copy an anchor, but with the given identifier. More...
const Id	getId () const
	Get the id of the anchor. More...
Offset	getOffset () const
	Get the offset of the anchor. More...
void	setOffset (Offset o)
	Set the offset of the anchor. More...
bool	getAnchored () const
	Get the anchored flag of the anchor. More...
void	setSignals (string signals)
	Set the signals of the anchor. More...
string	getSignals () const
	Get the signals of the anchor. More...
void	setUnit (string unit)
	Set the unit of the anchor. More...
Unit	getUnit () const
	Get the unit of the anchor. More...
string	toString ()
	Dump the anchor in AIF format. More...
Protected Methods
void	unsetOffset ()
	Unset the offset. More...
Friends
class	AG
class	AnnotationIndex
bool	operator< (const Anchor &, const Anchor &)
	Comparison of two anchors. More...

---

Detailed Description

An anchor is a named offset into signal data.

Author(s):

Xiaoyi Ma

Version:

1.3 September 21, 2001

Note:

anchors are not required to have an offset; two logically distinct anchors may have the same offset. An anchor with an offset is said to be anchored, otherwise unanchored.

---

Constructor & Destructor Documentation

Anchor::Anchor ( Id id, Offset offset, Unit unit, string signals )

Create an anchor, using the given identifier.

Anchor::Anchor ( Id id, Unit unit, string signals )

Create an anchor, using a given identifier, but without specifying its offset.

Anchor::Anchor ( Id id, const Anchor * )

Copy an anchor, but with the given identifier.

---

Member Function Documentation

bool Anchor::getAnchored ( ) const [inline]

Get the anchored flag of the anchor.

const Id Anchor::getId ( ) const [inline]

Get the id of the anchor.

Offset Anchor::getOffset ( ) const [inline]

Get the offset of the anchor.

string Anchor::getSignals ( ) const [inline]

Get the signals of the anchor.

Unit Anchor::getUnit ( ) const [inline]

Get the unit of the anchor.

void Anchor::setOffset ( Offset o ) [inline]

Set the offset of the anchor.

void Anchor::setSignals ( string signals ) [inline]

Set the signals of the anchor.

void Anchor::setUnit ( string unit ) [inline]

Set the unit of the anchor.

string Anchor::toString ( )

Dump the anchor in AIF format.

void Anchor::unsetOffset ( ) [inline, protected]

Unset the offset.

---

Friends And Related Function Documentation

class AG [friend]

class AnnotationIndex [friend]

bool operator< ( const Anchor &, const Anchor & ) [friend]

Comparison of two anchors.

---

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

• Anchor.h

---