name: Char : public SysChar

synopsis:

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

#include <Char.h>

Char(char arg = DEF_VALUE);
Char(const Char& arg);

quick start:

Char* ptr;
ptr = new Char();
ptr->assign(L'5');
delete ptr;

Char val0;
val0.assign((unichar)'w');
Char val1(val0);

description:

The Char class inherits the SysChar class functionality. We only add I/O methods and scalar type conversions to SysChar, to enable Char to become a complete scalar object. The reason for having both Char and SysChar classes is that one is needed at the bottom of the class hierarchical structure to be used by lower-level classes including the I/O classes. The Char class is above the i/o layer, so it can inherit the I/O methods that are not known at the SysChar level.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"Char";

static const String DEF_PARAM = L"value";

error codes:

error code indicating console class general error:
```
static const long ERR = 20300;
```

protected data:

a 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:

setDebug is inherited from the SysChar class

boolean debug(const unichar* message) const;

destructor/constructor(s):

~Char();

Char(unichar arg = DEF_VALUE);

Char(const Char& arg);

assign methods:

assign methods are inherited from the SysChar class

operator= methods:
```
Char& operator= (const Char& 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& name= DEF_PARAM) const;

equality methods:

equality methods are inherited from the SysChar class

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);

clear is inherited from the SysChar class

class-specific public methods:

constructors:

Char(const byte* data, ENCODE encoding = DEF_ENCODE);

private methods:

none.

examples:

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

Char val0;
val0.assign((unichar)'h');
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.
See the notes section of SysChar.