name: MachineDatabase

synopsis:


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

#include <MachineDatabase.h>

boolean isEmpty();
String& getDataBaseName();
boolean setDataBaseName(String& arg);
Vector<Machine>& getDataBase();
boolean setDataBase(Vector<Machine>& arg);
boolean get(String& node, Machine& machine);

quick start:


String tmp_str;
MachineDatabase mdb_00;

tmp_str.assign(L"XYZ");
mdb.setDataBaseName(tmp_str);

description:

This class is used to represent a database of machines and their corresponding attributes.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"MachineDatabase";

define i/o related constants:

static const String DEF_PARAM;

static const String PARAM_NAME;

static const String PARAM_MACHINES;

error codes:

error codes indicating general errors:

protected data:

declare define the database name:

String name_d;

declare define the container object:

Vector<Machine> database_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):

~MachineDatabase();

MachineDatabase();

MachineDatabase(const MachineDatabase& arg);

assign methods:

boolean assign(const MachineDatabase& 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 MachineDatabase& 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 database property methods:

boolean isEmpty();

boolean get(String& node, Machine& machine);

declare database name methods:

String& getDataBaseName();

boolean setDataBaseName(String& arg);

declare database access methods:

Vector<Machine>& getDataBase();

boolean setDataBase(Vector<Machine>& arg);

private methods:

declare private methods:

examples:

This example shows how to use the MachineDatabase object.

notes:

none.