name: Anchor

synopsis:


g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_mmedia_a

#include <Anchor.h>

static boolean diagnose(Integral::DEBUG debug_level);
const String getId() const;
float getOffset() const;
boolean setOffset(float arg);
boolean getAnchored() const;
boolean setUnit(String& arg);
String getUnit() const;
boolean unsetOffset();

quick start:


Anchor ancr_00;
String unit_00(L"seconds");
ancr_00.setOffset(0.6);
ancr_00.setUnit(unit_00);

description:

This class is used to represent time offsets in the annotation graph.

[1] S. Bird, M. Liberman, A Formal Framework for Linguistic Annotation, Linguistic Data Consortium, University of Pennsylvania, Philadelphia, Pennsylvania, USA, 2000. [2] K. Maeda, X. Ma, H. Lee, S. Bird, The Annotation Graph Toolkit: Application Developer's Manual (Draft), Linguistic Data Consortium, University of Pennsylvania, Philadelphia, Pennsylvania, USA, 2001.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"Anchor";

i/o related constants:

static const String DEF_PARAM;

static const String PARAM_ID;

static const String PARAM_OFFSET;

static const String PARAM_UNIT;

static const String PARAM_ANCHORED;

error codes:

error codes indicating general errors:

protected data:

declare the anchor id:

String id_d;

declare the anchor offset:

Float offset_d;

declare the anchor time unit:

String unit_d;

declare a flag that indicates if the anchor is anchored:

Boolean anchored_d;

declare the debugging parameters:
```
static Integral::DEBUG debug_level_d;
```
declare the memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:
```
static const String& name();
```

debug methods:

boolean debug(const unichar* msg) const;

static boolean setDebug(Integral::DEBUG arg);

static boolean diagnose(Integral::DEBUG debug_level);

destructor/constructor(s):

~Anchor();

Anchor();

Anchor(const Anchor& arg);

Anchor(String& id, float offset, String& unit);

Anchor(String& id, String& unit);

Anchor(String& id, const Anchor*);

assign methods:
```
boolean assign(const Anchor& arg);
```
operator= method:
```
not present.
```

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag);

boolean read(Sof& sof, long tag, const String& name);

boolean write(Sof& sof, long tag) const;

boolean write(Sof& sof, long tag, const String& name) const;

boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);

boolean writeData(Sof& sof, const String& pname =  DEF_PARAM) const;

equality methods:
```
boolean eq(const Anchor& arg) const;
```

memory management methods:

static void* operator new(size_t arg);

static void* operator new[](size_t arg);

static void operator delete(void* arg);

static void operator delete[](void* arg);

static boolean setGrowSize(long arg);

boolean clear(Integral::CMODE cmode = Integral::DEF_CMODE);

class-specific public methods:

declare identifier methods:
```
const String getId() const;
```

declare offset methods:

float getOffset() const;

boolean setOffset(float arg);

boolean unsetOffset();

boolean getAnchored() const;

declare unit methods:

boolean setUnit(String& arg);

String getUnit() const;

private methods:

declare friend classes:

friend class AnnotationGraph;

declare private methods:

boolean compare(const String& arg1, const String& arg2) const;

examples:

This example shows how to use the Anchor object.

notes:

none.