name: History: public Stack <Context>

synopsis:

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

#include <History.h>

~History();
History();
History(const History& copy_hist);
History(const String& history);

quick start:

#include <History.h>

History hist;

GraphVertex vertex;
history.push(&vertex);

Trace trace;
trace->getHistory()->push(&vertex);
SearchNode* next_node = trace->getHistory()->peek()->getItem();

description:

History is a class to keep track of the history through a search. It acts like a stack where graph vertices can be pushed onto and popped off of the history list. The majority of the useful interface is inherited from the Stack class.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"History";

error codes:

error code indicating a general error:
```
static const long ERR = 90100;
```

protected data:

memory manager:
```
static MemoryManager mgr_d;
```
debug level:
```
static Integral::DEBUG debug_level_d;
```

required public methods:

static methods:

static const String& name();

static boolean diagnose(Integral::DEBUG debug_level);

debug methods:

static boolean setDebug(Integral::DEBUG debug_level);

destructor/constructor(s):

~History();

History();

History(const History& arg);

assign methods:
```
not present.
```
operator= method:
```
not present.
```

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 = String::EMPTY, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);

boolean writeData(Sof& sof, const String& pname = String::EMPTY) 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 grow_size);

class-specific public methods:

primary interface for the History class is inherited from the Stack class

private methods:

none.

examples:

none.

notes:

none.