SAMRAI::tbox::Database Class Reference

Class Database is an abstract base class for the input, restart, and visualization databases. More...

#include <source/toolbox/database/Database.h>

Inheritance diagram for SAMRAI::tbox::Database:

[legend]List of all members.

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

---

Detailed Description

Class Database is an abstract base class for the input, restart, and visualization databases.

SAMRAI databases store (key,value) pairs in a hierarchical database. Each value may be another database or a boolean, box, character, double complex, double, float, integer, or string. DatabaseBoxes are stored using the toolbox box structure.

Data is entered into the database through methods of the general form putTYPE(key, TYPE) or putTYPEArray(key, TYPE array), where TYPE is the type of value created. If the specified key already exists in the database, then the existing key is silently deleted.

Data is extracted from the database through methods of the general form TYPE = getTYPE(key), where TYPE is the type of value to be returned from the database. There are two general lookup methods. In the first, a default value is provided (for scalars only). If the specified key is not found in the database, then the specified default is returned. In the second form, no default is provided, and the database exists with an error message and program exits if the key is not found. The array version of getTYPE() works in a similar fashion.

---

Constructor & Destructor Documentation

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

The constructor for the database base class does nothing interesting.

SAMRAI::tbox::Database::~Database (   )  [virtual]

The virtual destructor for the database base class does nothing interesting.

---

Member Function Documentation

virtual bool SAMRAI::tbox::Database::keyExists (  const string &  key  )  [pure virtual]

Return true if the specified key exists in the database and false otherwise. Parameters: key  Key name to lookup. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<string> SAMRAI::tbox::Database::getAllKeys (   )  [pure virtual]

Return all keys in the database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual int SAMRAI::tbox::Database::getArraySize (  const string &  key  )  [pure virtual]

Return the size of the array associated with the key. If the key does not exist, then zero is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isDatabase (  const string &  key  )  [pure virtual]

Return whether the specified key represents a database entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a new database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get the database with the specified key name. If the specified key does not exist in the database or it is not a database, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isBool (  const string &  key  )  [pure virtual]

Return whether the specified key represents a boolean entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a boolean scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a boolean array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a boolean array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::getBool (  const string &  key  )  [pure virtual]

Get a boolean entry in the database with the specified key name. If the specified key does not exist in the database or is not a boolean scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a boolean entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a boolean scalar, then an error message is printed and the program exits. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<bool> SAMRAI::tbox::Database::getBoolArray (  const string &  key  )  [pure virtual]

Get a boolean entry from the database with the specified key name. If the specified key does not exist in the database or is not a boolean array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a boolean entry from the database with the specified key name. If the specified key does not exist in the database or is not a boolean array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isDatabaseBox (  const string &  key  )  [pure virtual]

Return whether the specified key represents a box entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a box scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a box array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a box array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual DatabaseBox SAMRAI::tbox::Database::getDatabaseBox (  const string &  key  )  [pure virtual]

Get a box entry in the database with the specified key name. If the specified key does not exist in the database or is not a box scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a box entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a box scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<DatabaseBox> SAMRAI::tbox::Database::getDatabaseBoxArray (  const string &  key  )  [pure virtual]

Get a box entry from the database with the specified key name. If the specified key does not exist in the database or is not a box array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a box entry from the database with the specified key name. If the specified key does not exist in the database or is not a box array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isChar (  const string &  key  )  [pure virtual]

Return whether the specified key represents a character entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a character scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a character array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a character array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual char SAMRAI::tbox::Database::getChar (  const string &  key  )  [pure virtual]

Get a character entry in the database with the specified key name. If the specified key does not exist in the database or is not an character scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a character entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a character scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<char> SAMRAI::tbox::Database::getCharArray (  const string &  key  )  [pure virtual]

Get a character entry from the database with the specified key name. If the specified key does not exist in the database or is not a character array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a character entry from the database with the specified key name. If the specified key does not exist in the database or is not a character array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isComplex (  const string &  key  )  [pure virtual]

Return whether the specified key represents a complex entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a complex scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a complex array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a complex array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual dcomplex SAMRAI::tbox::Database::getComplex (  const string &  key  )  [pure virtual]

Get a complex entry in the database with the specified key name. If the specified key does not exist in the database or is not a complex scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a complex entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a complex scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<dcomplex> SAMRAI::tbox::Database::getComplexArray (  const string &  key  )  [pure virtual]

Get a complex entry from the database with the specified key name. If the specified key does not exist in the database or is not a complex array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a complex entry from the database with the specified key name. If the specified key does not exist in the database or is not a complex array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isDouble (  const string &  key  )  [pure virtual]

Return whether the specified key represents a double entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a double scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a double array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a double array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual double SAMRAI::tbox::Database::getDouble (  const string &  key  )  [pure virtual]

Get a double entry in the database with the specified key name. If the specified key does not exist in the database or is not a double scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a double entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a double scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<double> SAMRAI::tbox::Database::getDoubleArray (  const string &  key  )  [pure virtual]

Get a double entry from the database with the specified key name. If the specified key does not exist in the database or is not a double array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a double entry from the database with the specified key name. If the specified key does not exist in the database or is not a double array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isFloat (  const string &  key  )  [pure virtual]

Return whether the specified key represents a float entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a float scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a float array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a float array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual float SAMRAI::tbox::Database::getFloat (  const string &  key  )  [pure virtual]

Get a float entry in the database with the specified key name. If the specified key does not exist in the database or is not a float scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a float entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a float scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<float> SAMRAI::tbox::Database::getFloatArray (  const string &  key  )  [pure virtual]

Get a float entry from the database with the specified key name. If the specified key does not exist in the database or is not a float array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a float entry from the database with the specified key name. If the specified key does not exist in the database or is not a float array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isInteger (  const string &  key  )  [pure virtual]

Return whether the specified key represents an integer entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create an integer scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create an integer array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create an integer array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual int SAMRAI::tbox::Database::getInteger (  const string &  key  )  [pure virtual]

Get an integer entry in the database with the specified key name. If the specified key does not exist in the database or is not an integer scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get an integer entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not an integer scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<int> SAMRAI::tbox::Database::getIntegerArray (  const string &  key  )  [pure virtual]

Get an integer entry from the database with the specified key name. If the specified key does not exist in the database or is not an integer array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get an integer entry from the database with the specified key name. If the specified key does not exist in the database or is not an integer array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual bool SAMRAI::tbox::Database::isString (  const string &  key  )  [pure virtual]

Return whether the specified key represents a string entry. If the key does not exist, then false is returned. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a string scalar entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Value to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a string array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Create a string array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual string SAMRAI::tbox::Database::getString (  const string &  key  )  [pure virtual]

Get a string entry in the database with the specified key name. If the specified key does not exist in the database or is not an string scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual string SAMRAI::tbox::Database::getStringWithDefault (  const string &  key, const string &  defaultvalue )  [pure virtual]

Get a string entry in the database with the specified key name. If the specified key does not exist in the database, then the default value is returned. If the key exists but is not a string scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. defaultvalue  Default value to return if not found. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

virtual Array<string> SAMRAI::tbox::Database::getStringArray (  const string &  key  )  [pure virtual]

Get a string entry from the database with the specified key name. If the specified key does not exist in the database or is not a string array, then an error message is printed and the program exits. Parameters: key  Key name in database. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

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

Get a string entry from the database with the specified key name. If the specified key does not exist in the database or is not a string array, then an error message is printed and the program exits. The specified number of elements must match exactly the number of elements in the array in the database. Parameters: key  Key name in database. data  Array with data to put into database. nelements  Number of elements to write from array. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

void SAMRAI::tbox::Database::getScalar (  const string &  key, bool &  scalar )

Get a bool entry in the database with the specified key name. If the specified key does not exist in the database or is not an bool scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Returns scalar that was read.

void SAMRAI::tbox::Database::putScalar (  const string &  key, const bool  scalar )

Get a bool entry from the database with the specified key name. If the specified key does not exist in the database or is not a bool array, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Value to put into database.

void SAMRAI::tbox::Database::getArray (  const string &  key, Array< bool > &  array )

Get a bool entry from the database with the specified key name. If the specified key does not exist in the database or is not a bool array, then an error message is printed and the program exits. Parameters: key  Key name in database. array  Returns array that was read.

void SAMRAI::tbox::Database::putArray (  const string &  key, const Array< bool >  array )

Create an bool array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. array  Array to put into database.

void SAMRAI::tbox::Database::getScalar (  const string &  key, char &  scalar )

Get a char entry in the database with the specified key name. If the specified key does not exist in the database or is not an char scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Returns scalar that was read.

void SAMRAI::tbox::Database::putScalar (  const string &  key, const char  scalar )

Get a char entry from the database with the specified key name. If the specified key does not exist in the database or is not a char array, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Value to put into database.

void SAMRAI::tbox::Database::getArray (  const string &  key, Array< char > &  array )

Get a char entry from the database with the specified key name. If the specified key does not exist in the database or is not a char array, then an error message is printed and the program exits. Parameters: key  Key name in database. array  Returns array that was read.

void SAMRAI::tbox::Database::putArray (  const string &  key, const Array< char >  array )

Create an char array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. array  Array to put into database.

void SAMRAI::tbox::Database::getScalar (  const string &  key, dcomplex &  scalar )

Get a complex entry in the database with the specified key name. If the specified key does not exist in the database or is not an complex scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Returns scalar that was read.

void SAMRAI::tbox::Database::putScalar (  const string &  key, const dcomplex  scalar )

Get a complex entry from the database with the specified key name. If the specified key does not exist in the database or is not a complex array, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Value to put into database.

void SAMRAI::tbox::Database::getArray (  const string &  key, Array< dcomplex > &  array )

Get a complex entry from the database with the specified key name. If the specified key does not exist in the database or is not a complex array, then an error message is printed and the program exits. Parameters: key  Key name in database. array  Returns array that was read.

void SAMRAI::tbox::Database::putArray (  const string &  key, const Array< dcomplex >  array )

Create an complex array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. array  Array to put into database.

void SAMRAI::tbox::Database::getScalar (  const string &  key, float &  scalar )

Get a float entry in the database with the specified key name. If the specified key does not exist in the database or is not an float scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Returns scalar that was read.

void SAMRAI::tbox::Database::putScalar (  const string &  key, const float  scalar )

Get a float entry from the database with the specified key name. If the specified key does not exist in the database or is not a float array, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Value to put into database.

void SAMRAI::tbox::Database::getArray (  const string &  key, Array< float > &  array )

Get a float entry from the database with the specified key name. If the specified key does not exist in the database or is not a float array, then an error message is printed and the program exits. Parameters: key  Key name in database. array  Returns array that was read.

void SAMRAI::tbox::Database::putArray (  const string &  key, const Array< float >  array )

Create an float array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. array  Array to put into database.

void SAMRAI::tbox::Database::getScalar (  const string &  key, double &  scalar )

Get a double entry in the database with the specified key name. If the specified key does not exist in the database or is not an double scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Returns scalar that was read.

void SAMRAI::tbox::Database::putScalar (  const string &  key, const double  scalar )

Get a double entry from the database with the specified key name. If the specified key does not exist in the database or is not a double array, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Value to put into database.

void SAMRAI::tbox::Database::getArray (  const string &  key, Array< double > &  array )

Get a double entry from the database with the specified key name. If the specified key does not exist in the database or is not a double array, then an error message is printed and the program exits. Parameters: key  Key name in database. array  Returns array that was read.

void SAMRAI::tbox::Database::putArray (  const string &  key, const Array< double >  array )

Create an double array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. array  Array to put into database.

void SAMRAI::tbox::Database::getScalar (  const string &  key, int &  scalar )

Get a integer entry in the database with the specified key name. If the specified key does not exist in the database or is not an integer scalar, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Returns scalar that was read.

void SAMRAI::tbox::Database::putScalar (  const string &  key, const int  scalar )

Get a integer entry from the database with the specified key name. If the specified key does not exist in the database or is not a integer array, then an error message is printed and the program exits. Parameters: key  Key name in database. scalar  Value to put into database.

void SAMRAI::tbox::Database::getArray (  const string &  key, Array< int > &  array )

Get a integer entry from the database with the specified key name. If the specified key does not exist in the database or is not a integer array, then an error message is printed and the program exits. Parameters: key  Key name in database. array  Returns array that was read.

void SAMRAI::tbox::Database::putArray (  const string &  key, const Array< int >  array )

Create an integer array entry in the database with the specified key name. If the key already exists in the database, then the old key record is deleted and the new one is silently created in its place. Parameters: key  Key name in database. array  Array to put into database.

virtual void SAMRAI::tbox::Database::printClassData (  ostream &  os = pout  )  [pure virtual]

Print the current database to the specified output stream. If no output stream is specified, then data is written to stream pout. Parameters: os  Output stream. Implemented in SAMRAI::tbox::InputDatabase, SAMRAI::tbox::HDFDatabase, and SAMRAI::tbox::NullDatabase.

---

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

• source/toolbox/database/Database.h
• source/toolbox/database/Database.C
• source/toolbox/database/Database.I

---