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

SAMRAI::tbox::HDFDatabase Class Reference

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

Inheritance diagram for SAMRAI::tbox::HDFDatabase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 HDFDatabase (const string &name)
virtual ~HDFDatabase ()
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)
virtual int mount (const string &file_name, const string &flags)
virtual void unmount ()
hid_t getGroupId ()

Detailed Description

Class HDFDatabase implements the interface of the Database class to store data in the HDF5 (Hierarchical Data Format) data format.

It is assumed that all processors will access the database in the same manner. Error reporting is done using the SAMRAI error reporting macros.

See also:
tbox::Database

Constructor & Destructor Documentation

SAMRAI::tbox::HDFDatabase::HDFDatabase (  const string &  name  ) 
 

The HDF database constructor creates an empty database with the specified name. By default the database will not be associated with a file until it is mounted, using the mount() member function.

When assertion checking is active, the name string must be non-empty.

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

The database destructor closes the HDF5 group or data file.

Member Function Documentation

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

Return true if the specified key exists in the database and false otherwise.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return an array of all keys in the current database. Note that no keys from subdatabases contained in the current database will appear in the array. To get the keys of any other database, you must call this routine for that database.

Implements SAMRAI::tbox::Database.

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

Return the size of the array associated with the key. If the key does not exist, then zero is returned.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a database entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a new database with the specified key name and return a pointer to it. A new group with the key name is also created in the data file.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get the database with the specified key name. If the specified key does not represent a database entry in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a boolean entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a boolean scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a boolean array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a boolean array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a boolean entry in the database with the specified key name. If the specified key does not exist in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

bool SAMRAI::tbox::HDFDatabase::getBoolWithDefault (  const string &  key,
const bool &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a boolean entry from the database with the specified key name. If the specified key does not exist in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a boolean entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a box entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a box scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a box array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a box array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a box entry in the database with the specified key name. If the specified key does not exist in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

DatabaseBox SAMRAI::tbox::HDFDatabase::getDatabaseBoxWithDefault (  const string &  key,
const DatabaseBox &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a box entry from the database with the specified key name. If the specified key does not exist in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a box entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a char entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a character scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a character array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a character array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a character entry in the database with the specified key name. If the specified key does not exist in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

char SAMRAI::tbox::HDFDatabase::getCharWithDefault (  const string &  key,
const char &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a character entry from the database with the specified key name. If the specified key does not exist in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a character entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a complex entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a complex scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a complex array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a complex array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a complex entry in the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

dcomplex SAMRAI::tbox::HDFDatabase::getComplexWithDefault (  const string &  key,
const dcomplex &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a complex entry from the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a complex entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a double entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a double scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a double array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a double array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a double entry in the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

double SAMRAI::tbox::HDFDatabase::getDoubleWithDefault (  const string &  key,
const double &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a double entry from the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a double entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a float entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a float scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a float array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a float array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a float entry in the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

float SAMRAI::tbox::HDFDatabase::getFloatWithDefault (  const string &  key,
const float &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a float entry from the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a float entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents an integer entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create an integer scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create an integer array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create an integer array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get an integer entry in the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

int SAMRAI::tbox::HDFDatabase::getIntegerWithDefault (  const string &  key,
const int &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get an integer entry from the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get an integer entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Return true or false depending on whether the specified key represents a string entry. If the key does not exist or if the string is empty, then false is returned.

Implements SAMRAI::tbox::Database.

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

Create a string scalar entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a string array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Create a string array entry in the database with the specified key name.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a string entry in the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

string SAMRAI::tbox::HDFDatabase::getStringWithDefault (  const string &  key,
const string &  defaultvalue
)  [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.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a string entry from the database with the specified key name. If the specified key does not exist in the database then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Get a string entry from the database with the specified key name. If the specified key does not exist in the database, or the given number of elements does no match the number of elements in the database, then an error message is printed and the program exits.

When assertion checking is active, the key string must be non-empty.

Implements SAMRAI::tbox::Database.

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

Print contents of current database to the specified output stream. If no output stream is specified, then data is written to stream pout. Note that none of the subdatabases contained in the current database will have their contents printed. To view the contents of any other database, you must call this print routine for that database.

Implements SAMRAI::tbox::Database.

int SAMRAI::tbox::HDFDatabase::mount (  const string &  file_name,
const string &  flags
)  [virtual]
 

Open a database file using the fileName. The file name string is the name of the file to open. The flags string is the name of the file status: possible values are "R" for read only and "W" for write.

When assertion checking is active, strings must be non-empty.

void SAMRAI::tbox::HDFDatabase::unmount (   )  [virtual]
 

Close the database file.

hid_t SAMRAI::tbox::HDFDatabase::getGroupId (   ) 
 

Return the group_id so VisIt can access an object's HDF database.

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