name: ContextMap

synopsis:


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

#include <ContextMap.h>

Vector<SearchSymbol>& getContext();
boolean setContext(Vector<SearchSymbol>& arg);
Ulong getContextIndex();
boolean setContextIndex(ulong arg);

quick start:


Vector<SearchSymbol> symbols;

ContextMap cmap;
cmap.setContext(symbols);
cmap.setContextIndex(0);

description:

This class provides a mapping between a sequence (context dependent / independent) at the current level of the search hierarchy and their corresponding subgraphs at the next level.

dependencies:

SearchSymbol.h

public constants:

define the class name:
```
static const String CLASS_NAME;
```

define i/o related constants:

static const String DEF_PARAM;

static const String PARAM_CONTEXT;

static const String PARAM_CONTEXT_INDEX;

error codes:

error codes indicating general errors:

protected data:

declare sequence of search symbols:

Vector<SearchSymbol> context_d;

declare subgraph index of the search symbols:

Ulong index_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:

static boolean diagnose(Integral::DEBUG debug_level);

boolean debug(const unichar* message) const;

destructor/constructor(s):

~ContextMap();

ContextMap();

ContextMap(const ContextMap& arg);

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

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag, const String& cname = CLASS_NAME);

boolean write(Sof& sof, long tag, const String& cname = CLASS_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 ContextMap& arg) const;

memory management methods:

static void* operator new(size_t size);

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

static void operator delete(void* ptr);

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

static boolean setGrowSize(long grow_size);

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

class-specific public methods:

declare context symbol methods:

Vector<SearchSymbol>& getContext();

boolean setContext(Vector<SearchSymbol>& arg);

declare context index methods:

Ulong getContextIndex();

boolean setContextIndex(ulong arg);

private methods:

declare private methods:

examples:

none.

notes:

none.