name: DebugLevel: public Long

synopsis:

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

#include <DebugLevel.h>

DebugLevel(Integral::DEBUG arg = Integral::DEF_DEBUG);
Long(const DebugLevel& arg);

quick start:

DebugLevel val0;
val0 = Integral::ALL;

if (val1 > Integral::BRIEF) {
   String output(L"printing some detailed debugging information");
   Console::put(output);
}

description:

The DebugLevel class mainly serves as a wrapper for the standard debug levels supported in the ISIP environment. It is used by classes that need to write a debug level to a file and utilities that need to specify the debug level as an argument. The DebugLevel class is a trivial extension of the scalar class Long.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"DebugLevel";

define a name map containing the enumerated values for debug levels:
```
static const NameMap LEVEL_MAP = L"NONE, BRIEF, DETAILED, ALL";
```

define a name/value tag for i/o:

static const String DEF_PARAM = L"debug_level";

error codes:

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

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: the setDebug method is inherited from the Long class
```
boolean debug(const unichar* message) const;
```

destructor/constructor(s):

~DebugLevel();

DebugLevel(Integral::DEBUG arg = Integral::DEF_DEBUG);

DebugLevel(const DebugLevel& arg);

DebugLevel(const String& arg);

assign methods:

assign methods are inherited from the class Long

operator= methods:

DebugLevel& operator=(const DebugLevel& arg);

i/o methods: the sofSize method is inherited is inherited from the Long class

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:

these methods are inherited from the Long class

memory management methods: the clear method is inherited from the Long class

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

class-specific public methods:

operator = methods:

DebugLevel& operator= (Integral::DEBUG arg);

operator > methods:

boolean operator> (Integral::DEBUG arg);

operator >= methods:

boolean operator>= (Integral::DEBUG arg);

operator != methods:

boolean operator!= (Integral::DEBUG arg);

operator < methods:

boolean operator< (Integral::DEBUG arg);

operator <= methods:

boolean operator<= (Integral::DEBUG arg);

operator == methods:

boolean operator== (Integral::DEBUG arg);

assign methods:

boolean assign(Integral::DEBUG arg);

boolean assign(const String& arg);

get methods;

Integral::DEBUG getIndex(const String& arg) const;

Integral::DEBUG getIndex() const;

const String& getName() const;

operator Integral::DEBUG() const;

operator const String&() const;

private methods:

none

examples:

This example shows how to write a DebugLevel object into a Sof file

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

This example shows how to do some simple assignments and comparisons

DebugLevel val0(Integral::ALL);

if (val0 > Integral::BRIEF) {
   String output(L"printing some detailed debugging information");
   Console::put(output);
}

DebugLevel val1;
val1 = Integral::DETAILED;

if (val1 > Integral::BRIEF) {
   String output(L"printing some detailed debugging information");
   Console::put(output);
}

notes:

none