Overture  Version 25
Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
HDF_DataBase Class Reference

#include <HDF5_DataBase.h>

Inheritance diagram for HDF_DataBase:
Inheritance graph
[legend]
Collaboration diagram for HDF_DataBase:
Collaboration graph
[legend]

Public Member Functions

 HDF_DataBase ()
 
 HDF_DataBase (const HDF_DataBase &)
 
 HDF_DataBase (const GenericDataBase &)
 
virtual GenericDataBasevirtualConstructor () const
 
 ~HDF_DataBase ()
 
HDF_DataBaseoperator= (const HDF_DataBase &)
 
GenericDataBaseoperator= (const GenericDataBase &)
 
int mount (const aString &fileName, const aString &flags="I")
 
int unmount ()
 
int flush ()
 
virtual int getID () const
 
virtual int build (GenericDataBase &db, int id)
 
int isNull () const
 
int create (GenericDataBase &db, const aString &name, const aString &dirClassName)
 
int link (GenericDataBase &db, const HDF_DataBase &parent, const aString &name)
 
int find (GenericDataBase &db, const aString &name, const aString &dirClassName="directory") const
 
int locate (GenericDataBase &db, const aString &name, const aString &dirClassName="directory") const
 
virtual int find (aString *name, const aString &dirClassName, const int &maxNumber, int &actualNumber) const
 
virtual int find (GenericDataBase *db, aString *name, const aString &dirClassName, const int &maxNumber, int &actualNumber) const
 
virtual int turnOnWarnings ()
 
virtual int turnOffWarnings ()
 
int put (const float &x, const aString &name)
 
int put (const double &x, const aString &name)
 
int put (const int &x, const aString &name)
 
int put (const aString &x, const aString &name)
 
int put (const bool &x, const aString &name)
 
int get (float &x, const aString &name) const
 
int get (double &x, const aString &name) const
 
int get (int &x, const aString &name) const
 
int get (aString &x, const aString &name) const
 
int get (bool &x, const aString &name) const
 
virtual int put (const floatSerialArray &x, const aString &name)
 
virtual int put (const doubleSerialArray &x, const aString &name)
 
virtual int put (const intSerialArray &x, const aString &name)
 
virtual int putDistributed (const floatArray &x, const aString &name)
 
virtual int putDistributed (const doubleArray &x, const aString &name)
 
virtual int putDistributed (const intArray &x, const aString &name)
 
virtual int get (floatSerialArray &x, const aString &name, Index *Iv=NULL) const
 
virtual int get (doubleSerialArray &x, const aString &name, Index *Iv=NULL) const
 
virtual int get (intSerialArray &x, const aString &name, Index *Iv=NULL) const
 
virtual int getDistributed (floatArray &x, const aString &name) const
 
virtual int getDistributed (doubleArray &x, const aString &name) const
 
virtual int getDistributed (intArray &x, const aString &name) const
 
int put (const int x[], const aString &name, const int number)
 
int put (const float x[], const aString &name, const int number)
 
int put (const double x[], const aString &name, const int number)
 
int put (const aString x[], const aString &name, const int number)
 
int get (int x[], const aString &name, const int number) const
 
int get (float x[], const aString &name, const int number) const
 
int get (double x[], const aString &name, const int number) const
 
int get (aString x[], const aString &name, const int number) const
 
void printStatistics () const
 
virtual void setMode (const InputOutputMode &mode=normalMode)
 
int putSM (const floatArray &x, const aString &name)
 
int getSM (floatArray &x, const aString &name)
 
- Public Member Functions inherited from GenericDataBase
 GenericDataBase ()
 
 GenericDataBase (const GenericDataBase &)
 
virtual ~GenericDataBase ()
 
ReferenceCountingListgetList () const
 
virtual InputOutputMode getMode () const
 
int getNumberOfLocalFilesForReading () const
 
int getNumberOfLocalFilesForWriting () const
 

Static Public Attributes

static int debug = 0
 

Protected Types

enum  AcessModeEnum { none, write, read }
 

Protected Member Functions

int close ()
 
void reference (const HDF_DataBase &db)
 
void destroy ()
 
void closeStream () const
 
int closeLocalFile (int p, AcessModeEnum accessMode) const
 
int getFileGroup (int p, AcessModeEnum accessMode) const
 
aString getSerialArrayName (const aString &fullGroupPath, const aString &name, const int p) const
 
aString getSerialFileName (const int p, AcessModeEnum accessMode) const
 
HDF_DataBaseopenLocalFile (int p, AcessModeEnum accessMode) const
 

Protected Attributes

enum HDF_DataBase::AcessModeEnum accessMode
 
bool bufferWasCreatedInThisDirectory
 
int fileID
 
aString fileName
 
aString fullGroupPath
 
int processorForWriting
 
DataBaseBufferdataBaseBuffer
 
HDF_DataBase ** serialDataBase
 
- Protected Attributes inherited from GenericDataBase
InputOutputMode mode
 
int issueWarnings
 
ReferenceCountingListreferenceCountingList
 
int numberOfLocalFilesForWriting
 
int numberOfLocalFilesForReading
 
int numberOfProcessorsUsedToWriteFile
 

Additional Inherited Members

- Public Types inherited from GenericDataBase
enum  InputOutputMode {
  normalMode =0, streamInputMode, streamOutputMode, noStreamMode,
  bufferMode
}
 
enum  ParallelIOModeEnum { independentIO, collectiveIO, multipleFileIO }
 
- Static Public Member Functions inherited from GenericDataBase
static void setParallelWriteMode (ParallelIOModeEnum mode)
 
static void setParallelReadMode (ParallelIOModeEnum mode)
 
static ParallelIOModeEnum getParallelWriteMode ()
 
static ParallelIOModeEnum getParallelReadMode ()
 
static int setMaximumNumberOfFilesForWriting (int maxNumberOfFiles)
 
- Public Attributes inherited from GenericDataBase
aString className
 
aString OvertureVersion
 
- Static Protected Attributes inherited from GenericDataBase
static ParallelIOModeEnum parallelReadMode =GenericDataBase::multipleFileIO
 
static ParallelIOModeEnum parallelWriteMode =GenericDataBase::multipleFileIO
 
static int maximumNumberOfLocalFilesForWriting =128
 

Member Enumeration Documentation

Enumerator
none 
write 
read 

Constructor & Destructor Documentation

HDF_DataBase::HDF_DataBase ( )
HDF_DataBase::HDF_DataBase ( const HDF_DataBase db)
HDF_DataBase::HDF_DataBase ( const GenericDataBase db)
HDF_DataBase::~HDF_DataBase ( )

Member Function Documentation

int HDF_DataBase::build ( GenericDataBase db,
int  id 
)
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::close ( )
protected

Referenced by destroy().

int HDF_DataBase::closeLocalFile ( int  p,
AcessModeEnum  accessMode 
) const
protected
void HDF_DataBase::closeStream ( ) const
protected
int HDF_DataBase::create ( GenericDataBase db,
const aString name,
const aString dirClassName 
)
virtual
void HDF_DataBase::destroy ( )
protected

References close().

int HDF_DataBase::find ( GenericDataBase db,
const aString name,
const aString dirClassName = "directory" 
) const
virtual
int HDF_DataBase::find ( aString name,
const aString dirClassName,
const int &  maxNumber,
int &  actualNumber 
) const
virtual

Reimplemented from GenericDataBase.

References assert, and NULL.

int HDF_DataBase::find ( GenericDataBase db,
aString name,
const aString dirClassName,
const int &  maxNumber,
int &  actualNumber 
) const
virtual

Reimplemented from GenericDataBase.

References assert, fullGroupPath, and NULL.

int HDF_DataBase::flush ( )
virtual

Reimplemented from GenericDataBase.

References assert, closeStream(), dataBaseBuffer, fileID, fullGroupPath, and NULL.

int HDF_DataBase::get ( float &  x,
const aString name 
) const
virtual
int HDF_DataBase::get ( double &  x,
const aString name 
) const
virtual
int HDF_DataBase::get ( int &  x,
const aString name 
) const
virtual
int HDF_DataBase::get ( aString x,
const aString name 
) const
virtual
int HDF_DataBase::get ( bool &  x,
const aString name 
) const
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::get ( floatSerialArray &  x,
const aString name,
Index *  Iv = NULL 
) const
virtual
int HDF_DataBase::get ( doubleSerialArray &  x,
const aString name,
Index *  Iv = NULL 
) const
virtual
int HDF_DataBase::get ( intSerialArray &  x,
const aString name,
Index *  Iv = NULL 
) const
virtual
int HDF_DataBase::get ( int  x[],
const aString name,
const int  number 
) const
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::get ( float  x[],
const aString name,
const int  number 
) const
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::get ( double  x[],
const aString name,
const int  number 
) const
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::get ( aString  x[],
const aString name,
const int  number 
) const
virtual
int HDF_DataBase::getDistributed ( floatArray &  x,
const aString name 
) const
virtual
int HDF_DataBase::getDistributed ( doubleArray &  x,
const aString name 
) const
virtual
int HDF_DataBase::getDistributed ( intArray &  x,
const aString name 
) const
virtual
int HDF_DataBase::getFileGroup ( int  p,
AcessModeEnum  accessMode 
) const
protected

References assert.

int HDF_DataBase::getID ( ) const
virtual

Reimplemented from GenericDataBase.

aString HDF_DataBase::getSerialArrayName ( const aString fullGroupPath,
const aString name,
const int  p 
) const
protected

References aString, and sPrintF().

Referenced by getDistributed(), and putDistributed().

aString HDF_DataBase::getSerialFileName ( const int  p,
AcessModeEnum  accessMode 
) const
protected

References aString, and sPrintF().

int HDF_DataBase::getSM ( floatArray &  x,
const aString name 
)
int HDF_DataBase::isNull ( ) const
virtual

Reimplemented from GenericDataBase.

References fileID, fullGroupPath, and NULL.

Referenced by ShowFileReader::getFrame().

int HDF_DataBase::link ( GenericDataBase db,
const HDF_DataBase parent,
const aString name 
)
int HDF_DataBase::locate ( GenericDataBase db,
const aString name,
const aString dirClassName = "directory" 
) const
virtual
int HDF_DataBase::mount ( const aString fileName,
const aString flags = "I" 
)
virtual
HDF_DataBase * HDF_DataBase::openLocalFile ( int  p,
AcessModeEnum  accessMode 
) const
protected
HDF_DataBase & HDF_DataBase::operator= ( const HDF_DataBase db)
GenericDataBase & HDF_DataBase::operator= ( const GenericDataBase db)
virtual

Reimplemented from GenericDataBase.

References GenericDataBase::className.

void HDF_DataBase::printStatistics ( ) const
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::put ( const float &  x,
const aString name 
)
virtual
int HDF_DataBase::put ( const double &  x,
const aString name 
)
virtual
int HDF_DataBase::put ( const int &  x,
const aString name 
)
virtual
int HDF_DataBase::put ( const aString x,
const aString name 
)
virtual
int HDF_DataBase::put ( const bool &  x,
const aString name 
)
virtual

Reimplemented from GenericDataBase.

int HDF_DataBase::put ( const floatSerialArray &  x,
const aString name 
)
virtual

!! NOTE : floatSerialArray will be replaced by the macro argument!

!! NOTE : floatSerialArray will be replaced by the macro argument!

Reimplemented from GenericDataBase.

References Overture::abort(), accessMode, assert, closeStream(), dataBaseBuffer, debug, fileID, fullGroupPath, max(), GenericDataBase::mode, GenericDataBase::normalMode, GenericDataBase::noStreamMode, NULL, processorForWriting, DataBaseBuffer::putToBuffer(), GenericDataBase::streamOutputMode, and write.

int HDF_DataBase::put ( const doubleSerialArray &  x,
const aString name 
)
virtual

!! NOTE : doubleSerialArray will be replaced by the macro argument!

!! NOTE : doubleSerialArray will be replaced by the macro argument!

Reimplemented from GenericDataBase.

References Overture::abort(), accessMode, assert, closeStream(), dataBaseBuffer, debug, fileID, fullGroupPath, max(), GenericDataBase::mode, GenericDataBase::normalMode, GenericDataBase::noStreamMode, NULL, processorForWriting, DataBaseBuffer::putToBuffer(), GenericDataBase::streamOutputMode, and write.

int HDF_DataBase::put ( const intSerialArray &  x,
const aString name 
)
virtual

!! NOTE : intSerialArray will be replaced by the macro argument!

!! NOTE : intSerialArray will be replaced by the macro argument!

Reimplemented from GenericDataBase.

References Overture::abort(), accessMode, assert, closeStream(), dataBaseBuffer, debug, fileID, fullGroupPath, max(), GenericDataBase::mode, GenericDataBase::normalMode, GenericDataBase::noStreamMode, NULL, processorForWriting, DataBaseBuffer::putToBuffer(), GenericDataBase::streamOutputMode, and write.

int HDF_DataBase::put ( const int  x[],
const aString name,
const int  number 
)
virtual

Reimplemented from GenericDataBase.

References put().

int HDF_DataBase::put ( const float  x[],
const aString name,
const int  number 
)
virtual

Reimplemented from GenericDataBase.

References put().

int HDF_DataBase::put ( const double  x[],
const aString name,
const int  number 
)
virtual

Reimplemented from GenericDataBase.

References put().

int HDF_DataBase::put ( const aString  x[],
const aString name,
const int  number 
)
virtual
int HDF_DataBase::putDistributed ( const floatArray &  x,
const aString name 
)
virtual
int HDF_DataBase::putDistributed ( const doubleArray &  x,
const aString name 
)
virtual
int HDF_DataBase::putDistributed ( const intArray &  x,
const aString name 
)
virtual
int HDF_DataBase::putSM ( const floatArray &  x,
const aString name 
)
void HDF_DataBase::reference ( const HDF_DataBase db)
protected
void HDF_DataBase::setMode ( const InputOutputMode mode = normalMode)
virtual
int HDF_DataBase::turnOffWarnings ( )
virtual
int HDF_DataBase::turnOnWarnings ( )
virtual
int HDF_DataBase::unmount ( )
virtual
GenericDataBase * HDF_DataBase::virtualConstructor ( ) const
virtual

Reimplemented from GenericDataBase.

References HDF_DataBase().

Member Data Documentation

enum HDF_DataBase::AcessModeEnum HDF_DataBase::accessMode
protected
bool HDF_DataBase::bufferWasCreatedInThisDirectory
protected
DataBaseBuffer* HDF_DataBase::dataBaseBuffer
protected
int HDF_DataBase::debug = 0
static
int HDF_DataBase::fileID
protected
aString HDF_DataBase::fileName
protected

Referenced by HDF_DataBase(), mount(), and operator=().

aString HDF_DataBase::fullGroupPath
protected
int HDF_DataBase::processorForWriting
protected

Referenced by HDF_DataBase(), put(), and putDistributed().

HDF_DataBase** HDF_DataBase::serialDataBase
mutableprotected

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