name: String : public SysString

synopsis:

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

#include <String.h>

String(unichar* arg = DEF_VALUE);
String(const String& arg);

quick start:

String val0(L"hello, world");
String num0;
String num1;
String num2;
String num3;
Long scalar_long;
Double Scalar_double;

scalar_long.assign((long)43);
num0.assign(scalar_long);
scalar_long.get(num1);

Double scalar_double;
scalar_double.assign((double)43.0);
num2.assign(scalar_double);
scalar_double.get(num3);

description:

The String class is needed to extend the SysString class with i/o and scalar conversion methods. SysString is a low order class, below i/o, and String is a higher order class that is built on both the SysString and i/o classes.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"String";

static const String EMPTY = L"";

static const String DEF_PARAM = L"value";

DEF_CAPACITY and DEF_VALUE are inherited from the SysString class

error codes:

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

protected data:

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 SysString class

boolean debug(const unichar* message) const;

destructor/constructor(s):

~String();

String(long arg = DEF_CAPACITY);

String(const String& arg);

assign methods:

assign methods are inherited from the SysString class

operator= methods:
```
String& operator= (const String& 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:

equality methods are inherited from the SysString 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 SysString class

class-specific public methods:

constructors:
```
String(const unichar* arg);
```

random alphanumeric string generation methods:

boolean rand(long max_len = MAX_LENGTH, long min_len = 0);

method to get an empty string:
```
static const String& getEmptyString();
```
method to obtain a hash of the String value
```
long hash(long capacity) const;
```

private methods:

none.

examples:

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

String str((unichar*)L"hello, world");
String tmp_filename(L"foo");
Sof tmp_file;
tmp_file.open(tmp_filename, File::WRITE_ONLY, File::TEXT);
       
str.write(tmp_file, (long)0);
tmp_file.close();

notes:

none.