Main   Namespaces   Classes   Hierarchy   Annotated   Files   Compound   Global   Pages  

Book Class Reference

A book is just a database of BookNodes. More...

#include <Book.hpp>

Inheritance diagram for Book:
StateDB< HexBookNode >

List of all members.

Public Member Functions

 Book (const std::string &filename)
bool Exists (const HexState &pos) const
 Returns true if position exists in database.
bool Get (const HexState &pos, HexBookNode &data) const
 Returns true if get is successful.
bool Put (const HexState &brd, const HexBookNode &data)
 Returns true if put is successful.
void Flush ()
Statistics GetStatistics () const
std::string BDBStatistics ()

Static Public Attributes

static const std::string BOOK_DB_VERSION = "BENZENE_BOOK_VER_0001"
 Current version for book databases.

Detailed Description

A book is just a database of BookNodes.

Definition at line 85 of file Book.hpp.


Constructor & Destructor Documentation

Book::Book ( const std::string &  filename  )  [inline]

Definition at line 90 of file Book.hpp.


Member Function Documentation

std::string StateDB< HexBookNode >::BDBStatistics (  )  [inherited]
bool StateDB< HexBookNode >::Exists ( const HexState pos  )  const [inherited]

Returns true if position exists in database.

void StateDB< HexBookNode >::Flush (  )  [inherited]
bool StateDB< HexBookNode >::Get ( const HexState pos,
HexBookNode data 
) const [inherited]

Returns true if get is successful.

Statistics StateDB< HexBookNode >::GetStatistics (  )  const [inherited]
bool StateDB< HexBookNode >::Put ( const HexState brd,
const HexBookNode data 
) [inherited]

Returns true if put is successful.


Member Data Documentation

const std::string Book::BOOK_DB_VERSION = "BENZENE_BOOK_VER_0001" [static]

Current version for book databases.

Update this if BookNode changes to prevent old out-of-date books being loaded.

Definition at line 88 of file Book.hpp.


The documentation for this class was generated from the following files:


6 Jan 2011 Doxygen 1.6.3