Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages
SAMRAI::tbox::NullDatabase

SAMRAI::tbox::NullDatabase Class Reference

#include <source/toolbox/restartdb/NullDatabase.h>

Inheritance diagram for SAMRAI::tbox::NullDatabase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 NullDatabase ()
virtual ~NullDatabase ()
virtual bool keyExists (const string &key)
virtual Array< string > getAllKeys ()
virtual int getArraySize (const string &key)
virtual bool isDatabase (const string &key)
virtual Pointer< Database > putDatabase (const string &key)
virtual Pointer< Database > getDatabase (const string &key)
virtual bool isBool (const string &key)
virtual void putBool (const string &key, const bool &data)
virtual void putBoolArray (const string &key, const Array< bool > &data)
virtual void putBoolArray (const string &key, const bool *const data, const int nelements)
virtual bool getBool (const string &key)
virtual bool getBoolWithDefault (const string &key, const bool &defaultvalue)
virtual Array< bool > getBoolArray (const string &key)
virtual void getBoolArray (const string &key, bool *data, const int nelements)
virtual bool isDatabaseBox (const string &key)
virtual void putDatabaseBox (const string &key, const DatabaseBox &data)
virtual void putDatabaseBoxArray (const string &key, const Array< DatabaseBox > &data)
virtual void putDatabaseBoxArray (const string &key, const DatabaseBox *const data, const int nelements)
virtual DatabaseBox getDatabaseBox (const string &key)
virtual DatabaseBox getDatabaseBoxWithDefault (const string &key, const DatabaseBox &defaultvalue)
virtual Array< DatabaseBox > getDatabaseBoxArray (const string &key)
virtual void getDatabaseBoxArray (const string &key, DatabaseBox *data, const int nelements)
virtual bool isChar (const string &key)
virtual void putChar (const string &key, const char &data)
virtual void putCharArray (const string &key, const Array< char > &data)
virtual void putCharArray (const string &key, const char *const data, const int nelements)
virtual char getChar (const string &key)
virtual char getCharWithDefault (const string &key, const char &defaultvalue)
virtual Array< char > getCharArray (const string &key)
virtual void getCharArray (const string &key, char *data, const int nelements)
virtual bool isComplex (const string &key)
virtual void putComplex (const string &key, const dcomplex &data)
virtual void putComplexArray (const string &key, const Array< dcomplex > &data)
virtual void putComplexArray (const string &key, const dcomplex *const data, const int nelements)
virtual dcomplex getComplex (const string &key)
virtual dcomplex getComplexWithDefault (const string &key, const dcomplex &defaultvalue)
virtual Array< dcomplex > getComplexArray (const string &key)
virtual void getComplexArray (const string &key, dcomplex *data, const int nelements)
virtual bool isDouble (const string &key)
virtual void putDouble (const string &key, const double &data)
virtual void putDoubleArray (const string &key, const Array< double > &data)
virtual void putDoubleArray (const string &key, const double *const data, const int nelements)
virtual double getDouble (const string &key)
virtual double getDoubleWithDefault (const string &key, const double &defaultvalue)
virtual Array< double > getDoubleArray (const string &key)
virtual void getDoubleArray (const string &key, double *data, const int nelements)
virtual bool isFloat (const string &key)
virtual void putFloat (const string &key, const float &data)
virtual void putFloatArray (const string &key, const Array< float > &data)
virtual void putFloatArray (const string &key, const float *const data, const int nelements)
virtual float getFloat (const string &key)
virtual float getFloatWithDefault (const string &key, const float &defaultvalue)
virtual Array< float > getFloatArray (const string &key)
virtual void getFloatArray (const string &key, float *data, const int nelements)
virtual bool isInteger (const string &key)
virtual void putInteger (const string &key, const int &data)
virtual void putIntegerArray (const string &key, const Array< int > &data)
virtual void putIntegerArray (const string &key, const int *const data, const int nelements)
virtual int getInteger (const string &key)
virtual int getIntegerWithDefault (const string &key, const int &defaultvalue)
virtual Array< int > getIntegerArray (const string &key)
virtual void getIntegerArray (const string &key, int *data, const int nelements)
virtual bool isString (const string &key)
virtual void putString (const string &key, const string &data)
virtual void putStringArray (const string &key, const Array< string > &data)
virtual void putStringArray (const string &key, const string *const data, const int nelements)
virtual string getString (const string &key)
virtual string getStringWithDefault (const string &key, const string &defaultvalue)
virtual Array< string > getStringArray (const string &key)
virtual void getStringArray (const string &key, string *data, const int nelements)
virtual void printClassData (ostream &os=pout)

Detailed Description

The NullDatabase provides an implementation of the Database interface with empty methods for the purpose of reducing the the number of guards necessary in methods from other classes that use databases.

See the Database class documentation for a description of the generic database interface.

Constructor & Destructor Documentation

SAMRAI::tbox::NullDatabase::NullDatabase (   )  [inline]
 

The null database constructor creates an empty database with the name "null".

SAMRAI::tbox::NullDatabase::~NullDatabase (   )  [inline, virtual]
 

The input database destructor deallocates the data in the database.

Member Function Documentation

bool SAMRAI::tbox::NullDatabase::keyExists (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

Array< string > SAMRAI::tbox::NullDatabase::getAllKeys (   )  [inline, virtual]
 

Return an empty Array<string>.

Implements SAMRAI::tbox::Database.

int SAMRAI::tbox::NullDatabase::getArraySize (  const string &  key  )  [inline, virtual]
 

Always returns 0.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isDatabase (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

Pointer< Database > SAMRAI::tbox::NullDatabase::putDatabase (  const string &  key  )  [inline, virtual]
 

Returns a pointer to the null database.

Implements SAMRAI::tbox::Database.

Pointer< Database > SAMRAI::tbox::NullDatabase::getDatabase (  const string &  key  )  [inline, virtual]
 

Returns a pointer to the null database.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isBool (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putBool (  const string &  key,
const bool &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putBoolArray (  const string &  key,
const Array< bool > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putBoolArray (  const string &  key,
const bool *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::getBool (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::getBoolWithDefault (  const string &  key,
const bool &  defaultvalue
)  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

Array< bool > SAMRAI::tbox::NullDatabase::getBoolArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<bool>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getBoolArray (  const string &  key,
bool *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isDatabaseBox (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putDatabaseBox (  const string &  key,
const DatabaseBox &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putDatabaseBoxArray (  const string &  key,
const Array< DatabaseBox > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putDatabaseBoxArray (  const string &  key,
const DatabaseBox *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

DatabaseBox SAMRAI::tbox::NullDatabase::getDatabaseBox (  const string &  key  )  [inline, virtual]
 

Returns a zero dimension empty box.

Implements SAMRAI::tbox::Database.

DatabaseBox SAMRAI::tbox::NullDatabase::getDatabaseBoxWithDefault (  const string &  key,
const DatabaseBox &  defaultvalue
)  [inline, virtual]
 

Returns a zero dimension empty box.

Implements SAMRAI::tbox::Database.

Array< DatabaseBox > SAMRAI::tbox::NullDatabase::getDatabaseBoxArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<box>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getDatabaseBoxArray (  const string &  key,
DatabaseBox *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isChar (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putChar (  const string &  key,
const char &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putCharArray (  const string &  key,
const Array< char > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putCharArray (  const string &  key,
const char *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

char SAMRAI::tbox::NullDatabase::getChar (  const string &  key  )  [inline, virtual]
 

Always returns 0.

Implements SAMRAI::tbox::Database.

char SAMRAI::tbox::NullDatabase::getCharWithDefault (  const string &  key,
const char &  defaultvalue
)  [inline, virtual]
 

Always returns 0.

Implements SAMRAI::tbox::Database.

Array< char > SAMRAI::tbox::NullDatabase::getCharArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<char>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getCharArray (  const string &  key,
char *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isComplex (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putComplex (  const string &  key,
const dcomplex &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putComplexArray (  const string &  key,
const Array< dcomplex > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putComplexArray (  const string &  key,
const dcomplex *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

dcomplex SAMRAI::tbox::NullDatabase::getComplex (  const string &  key  )  [inline, virtual]
 

Returns a 0.0 + 0.0i

Implements SAMRAI::tbox::Database.

dcomplex SAMRAI::tbox::NullDatabase::getComplexWithDefault (  const string &  key,
const dcomplex &  defaultvalue
)  [inline, virtual]
 

Returns a 0.0 + 0.0i

Implements SAMRAI::tbox::Database.

Array< dcomplex > SAMRAI::tbox::NullDatabase::getComplexArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<dcomplex>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getComplexArray (  const string &  key,
dcomplex *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isDouble (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putDouble (  const string &  key,
const double &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putDoubleArray (  const string &  key,
const Array< double > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putDoubleArray (  const string &  key,
const double *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

double SAMRAI::tbox::NullDatabase::getDouble (  const string &  key  )  [inline, virtual]
 

Returns 0.0

Implements SAMRAI::tbox::Database.

double SAMRAI::tbox::NullDatabase::getDoubleWithDefault (  const string &  key,
const double &  defaultvalue
)  [inline, virtual]
 

Returns 0.0

Implements SAMRAI::tbox::Database.

Array< double > SAMRAI::tbox::NullDatabase::getDoubleArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<double>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getDoubleArray (  const string &  key,
double *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isFloat (  const string &  key  )  [inline, virtual]
 

Always return true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putFloat (  const string &  key,
const float &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putFloatArray (  const string &  key,
const Array< float > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putFloatArray (  const string &  key,
const float *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

float SAMRAI::tbox::NullDatabase::getFloat (  const string &  key  )  [inline, virtual]
 

Returns 0.0

Implements SAMRAI::tbox::Database.

float SAMRAI::tbox::NullDatabase::getFloatWithDefault (  const string &  key,
const float &  defaultvalue
)  [inline, virtual]
 

Returns 0.0

Implements SAMRAI::tbox::Database.

Array< float > SAMRAI::tbox::NullDatabase::getFloatArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<float>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getFloatArray (  const string &  key,
float *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isInteger (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putInteger (  const string &  key,
const int &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putIntegerArray (  const string &  key,
const Array< int > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putIntegerArray (  const string &  key,
const int *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

int SAMRAI::tbox::NullDatabase::getInteger (  const string &  key  )  [inline, virtual]
 

Returns 0.

Implements SAMRAI::tbox::Database.

int SAMRAI::tbox::NullDatabase::getIntegerWithDefault (  const string &  key,
const int &  defaultvalue
)  [inline, virtual]
 

Returns 0.

Implements SAMRAI::tbox::Database.

Array< int > SAMRAI::tbox::NullDatabase::getIntegerArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<int>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getIntegerArray (  const string &  key,
int *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::NullDatabase::isString (  const string &  key  )  [inline, virtual]
 

Always returns true.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putString (  const string &  key,
const string &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putStringArray (  const string &  key,
const Array< string > &  data
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::putStringArray (  const string &  key,
const string *const   data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

string SAMRAI::tbox::NullDatabase::getString (  const string &  key  )  [inline, virtual]
 

Returns and empty string.

Implements SAMRAI::tbox::Database.

string SAMRAI::tbox::NullDatabase::getStringWithDefault (  const string &  key,
const string &  defaultvalue
)  [inline, virtual]
 

Returns and empty string.

Implements SAMRAI::tbox::Database.

Array< string > SAMRAI::tbox::NullDatabase::getStringArray (  const string &  key  )  [inline, virtual]
 

Returns an empty Array<string>.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::getStringArray (  const string &  key,
string *  data,
const int  nelements
)  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

void SAMRAI::tbox::NullDatabase::printClassData (  ostream &  os = pout  )  [inline, virtual]
 

Does nothing.

Implements SAMRAI::tbox::Database.

The documentation for this class was generated from the following files:
Generated on Fri Dec 2 11:33:34 2005 for SAMRAI by  doxygen 1.4.2