name: Boolean

synopsis:

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

#include <Boolean.h>

Boolean(boolean arg = DEF_VALUE);
boolean assign(boolean arg);

quick start:

Boolean val0;  
val0.assign(true);

Boolean val1;
val1 = !val0;

description:

The Boolean class manages values of type bool. A Boolean object can read itself from (or write itself to) a Sof file. The Boolean class includes memory management methods which use the MemoryManager class to allocate or delete memory to or from the heap.

dependencies:

Mscalar

public constants:

define the class name:

static const String CLASS_NAME = L"Boolean";

i/o related constants:

static const String DEF_PARAM = L"value";

define the default value(s) of the class data:
```
static const boolean DEF_VALUE = false;
```

error codes:

error code indicating Boolean class general error:
```
static const long ERR = 20100;
```

protected data:

a boolean value:

boolean value_d;

define a static debug level for all objects of this class:
```
static Integral::DEBUG debug_level_d;
```
static memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:

static const String& name();

static boolean diagnose(Integral::DEBUG debug_level);

debug methods:

static boolean setDebug(Integral::DEBUG level_a);

boolean debug(const unichar* message) const;

destructor/constructor(s):

~Boolean();

Boolean(boolean arg = DEF_VALUE);

Boolean(const Boolean& arg);

assign methods:
```
boolean assign(const Boolean& arg);
```

operator= methods:

Boolean& operator= (const Boolean& arg);

i/o methods:

long sofSize() const;

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

boolean write(Sof& sof, long tag, const String& name = 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 Boolean& 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 size);

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

class-specific public methods:

assign methods:

boolean assign(boolean arg);

boolean assign(const String& arg);

equality and comparison methods:

boolean almostEqual(boolean arg);

boolean almostEqual(boolean arg, double, double);

operator overload methods:

Boolean& operator= (boolean arg);

operator boolean() const;

get methods:
```
boolean get(String& arg) const;
```

random number generation methods:

boolean rand(Random& generator = Random::GLOBAL);

memory size methods:
```
long memSize() const;
```

private methods:

none.

examples:

This example shows how to write a Boolean object into a Sof file:

Boolean val0(true);
String tmp_filename(L"foo");
Sof tmp_file;
tmp_file.open(tmp_filename, File::WRITE_ONLY, File::TEXT);
       
val0.write(tmp_file, (long)0);
tmp_file.close();

notes:

See the notes section of MScalar.