woss::WossDb Class Reference

Abstract class that provides the interface of databases. More...

#include <woss-db.h>

Inheritance diagram for woss::WossDb:

Collaboration diagram for woss::WossDb:

Public Member Functions
	WossDb (const ::std::string &name)
void	setDbName (const ::std::string &pathname)
::std::string	getDbName () const
void	setDebug (double flag=true)
bool	isUsingDebug () const
virtual bool	isValid ()
virtual bool	openConnection ()=0
virtual bool	finalizeConnection ()=0
virtual bool	closeConnection ()=0

Protected Member Functions
PathName	getPathName (const ::std::string &complete_path)

Protected Attributes
::std::string	db_name
bool	debug

Detailed Description

Abstract class that provides the interface of databases.

WossDb is the foundation of any database included in WOSS. It has the tasks of opening, setting up and closing a connection do a database. Technology dependant issues should be putted in a class that inherits from WossDb.No specific data behaviour is defined here, this will be provided in other abstract classes: this has been specifically done to divide db technology from data. A custom database would have to inherit from a technology dependant class and from a data behaviour class

See also

WossBathymetryDb, WossSedimentDb, WossSSPDb, WossResArrDb, WossResPressDb

Constructor & Destructor Documentation

WossDb()

WossDb::WossDb

(

const ::std::string &

name

)

WossDb constructor

Parameters

name	pathname of database

Member Function Documentation

closeConnection()

virtual bool woss::WossDb::closeConnection ( )

pure virtual

Closes the connection to the open database

Returns

true if method was successful, false otherwise

Implemented in woss::ResPressureTxtDb, woss::ResTimeArrTxtDb, woss::SedimDeck41Db, woss::WossNetcdfDb, and woss::WossTextualDb.

finalizeConnection()

virtual bool woss::WossDb::finalizeConnection ( )

pure virtual

Post openConnection() actions. E.g. creating variables, initializing special pointers etc...

Returns

true if method was successful, false otherwise

Implemented in woss::BathyGebcoDb, woss::BathyUtmCsvDb, woss::ResPressureTxtDb, woss::ResTimeArrTxtDb, woss::SedimDeck41CoordDb, woss::SedimDeck41Db, woss::SedimDeck41MarsdenDb, woss::SedimDeck41MarsdenOneDb, and woss::SspWoa2005Db.

Referenced by woss::WossDbCreator::initializeDb().

getDbName()

::std::string woss::WossDb::getDbName ( ) const

inline

Gets the pathname (or custom network address) of database file

Returns

pathname database pathname

References db_name.

getPathName()

PathName WossDb::getPathName ( const ::std::string &  complete_path )

protected

Gets path and database name separated

Returns

PathName value

See also

PathName

isUsingDebug()

bool woss::WossDb::isUsingDebug ( ) const

inline

Gets debug flag

Returns

true if using debug, false otherwise

References debug.

isValid()

virtual bool woss::WossDb::isValid ( )

inlinevirtual

Checks the validity of WossDb

Returns

true if pathname is valid, false otherwise

Reimplemented in woss::SedimDeck41CoordDb, woss::SedimDeck41MarsdenDb, and woss::SedimDeck41MarsdenOneDb.

References db_name.

Referenced by woss::SedimDeck41CoordDb::isValid(), woss::SedimDeck41MarsdenDb::isValid(), woss::SedimDeck41MarsdenOneDb::isValid(), and woss::WossNetcdfDb::openConnection().

openConnection()

virtual bool woss::WossDb::openConnection ( )

pure virtual

Opens the connection to the pathname provided

Returns

true if method was successful, false otherwise

Implemented in woss::SedimDeck41Db, woss::WossNetcdfDb, and woss::WossTextualDb.

Referenced by woss::WossDbCreator::initializeDb().

setDbName()

void woss::WossDb::setDbName ( const ::std::string &  pathname )

inline

Sets the pathname (or custom network address) of database file

Parameters

name	pathname database pathname

References db_name.

Referenced by woss::SedimDeck41DbCreator::initializeSedimDb().

setDebug()

void woss::WossDb::setDebug ( double  flag = true )

inline

Sets debug flag

Parameters

flag	debug flag

References debug.

Referenced by woss::WossDbCreator::initializeDb().

Member Data Documentation

db_name

::std::string woss::WossDb::db_name

protected

Pathname to database. It could be a filesystem pathname, or a network identifier etc...

Referenced by getDbName(), woss::BathyUtmCsvDb::importData(), woss::ResPressureBinDb::importMap(), woss::ResPressureTxtDb::importMap(), woss::ResTimeArrBinDb::importMap(), woss::ResTimeArrTxtDb::importMap(), woss::SedimDeck41CoordDb::isValid(), woss::SedimDeck41MarsdenDb::isValid(), woss::SedimDeck41MarsdenOneDb::isValid(), isValid(), woss::WossNetcdfDb::openConnection(), woss::WossTextualDb::openConnection(), setDbName(), woss::ResPressureBinDb::writeMap(), woss::ResPressureTxtDb::writeMap(), woss::ResTimeArrBinDb::writeMap(), and woss::ResTimeArrTxtDb::writeMap().

debug

bool woss::WossDb::debug

protected

Debug flag

Referenced by woss::SedimDeck41Db::calculateDeck41Types(), woss::SedimDeck41Db::calculateSediment(), woss::BathyGebcoDb::finalizeConnection(), woss::BathyGebcoDb::get1DBathyIndex(), woss::BathyGebcoDb::get2DBathyIndexes(), woss::BathyUtmCsvDb::getBathyIndex(), woss::SedimDeck41Db::getDeck41TypesFromCoords(), woss::SedimDeck41Db::getDeck41TypesFromMarsdenCoords(), woss::SedimDeck41Db::getDeck41TypesFromMarsdenSquare(), woss::SedimDeck41CoordDb::getSeaFloorType(), woss::SedimDeck41MarsdenDb::getSeaFloorType(), woss::SedimDeck41MarsdenOneDb::getSeaFloorType(), woss::SedimDeck41CoordDb::getSedimIndex(), woss::SedimDeck41CoordDb::getSedimIndexes(), woss::SspWoa2005Db::getSSPIndexes(), woss::SspWoa2005Db::getValue(), woss::BathyGebcoDb::getValue(), woss::BathyUtmCsvDb::getValue(), woss::BathyUtmCsvDb::importData(), woss::ResPressureBinDb::importMap(), woss::ResPressureTxtDb::importMap(), woss::ResTimeArrBinDb::importMap(), woss::ResTimeArrTxtDb::importMap(), woss::ResPressureTxtDb::insertValue(), woss::ResTimeArrTxtDb::insertValue(), isUsingDebug(), woss::ResTimeArrTxtDb::readMap(), and setDebug().

---

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

• woss/woss_db/woss-db.h
• woss/woss_db/woss-db.cpp