woss::WossDbCreator Class Reference

Abstract class that provides the interface of database creator ( Factory object ) More...

#include <woss-db-creator.h>

Inheritance diagram for woss::WossDbCreator:

Collaboration diagram for woss::WossDbCreator:

Public Member Functions
	WossDbCreator ()
virtual WossDb *const	createWossDb ()=0
WossDbCreator &	setDebug (bool flag)
WossDbCreator &	setWossDebug (bool flag)
WossDbCreator &	setDbPathName (const ::std::string &name)
bool	isUsingDebug () const
bool	isUsingWossDbDebug () const
::std::string	getDbPathName () const

Protected Member Functions
virtual bool	initializeDb (WossDb *const woss_db)=0

Protected Attributes
bool	debug
bool	woss_db_debug
::std::string	pathname

Detailed Description

Abstract class that provides the interface of database creator ( Factory object )

WossDbCreator is the prototype of any database creator included in WOSS. It has the tasks of creating and initializing a specific database object, thus abstracting the caller from specific implementation parameters, and the database itself from system specifics (c++ framework, NS-2 framework, NS-3 framework and so on...)

It also provides a Tcl interpreter for NS-2 implementation.

See also

BathyGebcoDbCreator, SedimDeck41DbCreator, SspWoa2005DbCreator, ResTimeArrTxtDbCreator, ResPressureTxtDbCreator

Constructor & Destructor Documentation

WossDbCreator()

WossDbCreator::WossDbCreator

(

)

Default WossDbCreator creator

Member Function Documentation

createWossDb()

virtual WossDb *const woss::WossDbCreator::createWossDb ( )

pure virtual

Abstract method. It is called to create and initialize a WossDb. The caller will be the owner of created object, therefore object destruction is his responsibility

Returns

a pointer to a properly initialized WossDb object

Implemented in woss::BathyGebcoDbCreator, woss::BathyUtmCsvDbCreator, woss::ResPressureBinDbCreator, woss::ResPressureTxtDbCreator, woss::ResTimeArrBinDbCreator, woss::ResTimeArrTxtDbCreator, woss::SedimDeck41DbCreator, and woss::SspWoa2005DbCreator.

References debug.

Referenced by woss::WossController::initialize().

initializeDb()

bool WossDbCreator::initializeDb ( WossDb *const  woss_db )

protectedpure virtual

Initializes the pointed object

Parameters

woss_db

pointer to a recently created WossDb

Returns

true if the method succeed, false otherwise

Implemented in woss::BathyGebcoDbCreator, woss::BathyUtmCsvDbCreator, woss::ResPressureBinDbCreator, woss::ResPressureTxtDbCreator, woss::ResTimeArrBinDbCreator, woss::ResTimeArrTxtDbCreator, woss::SspWoa2005DbCreator, and woss::SedimDeck41DbCreator.

References woss::WossDb::finalizeConnection(), woss::WossDb::openConnection(), woss::WossDb::setDebug(), and woss_db_debug.

Referenced by woss::BathyGebcoDbCreator::initializeDb(), woss::BathyUtmCsvDbCreator::initializeDb(), woss::ResPressureBinDbCreator::initializeDb(), woss::ResPressureTxtDbCreator::initializeDb(), woss::ResTimeArrBinDbCreator::initializeDb(), woss::ResTimeArrTxtDbCreator::initializeDb(), woss::SspWoa2005DbCreator::initializeDb(), and woss::SedimDeck41DbCreator::initializeDb().

Here is the call graph for this function:

Member Data Documentation

debug

bool woss::WossDbCreator::debug

protected

WossDbCreator debug flag binded in Tcl

Referenced by woss::ResTimeArrBinDbCreator::createWossDb(), woss::ResTimeArrTxtDbCreator::createWossDb(), and createWossDb().

pathname

::std::string woss::WossDbCreator::pathname

protected

Pathname or unique identifier

Referenced by woss::BathyGebcoDbCreator::createWossDb(), woss::BathyUtmCsvDbCreator::createWossDb(), woss::ResPressureBinDbCreator::createWossDb(), woss::ResPressureTxtDbCreator::createWossDb(), woss::ResTimeArrBinDbCreator::createWossDb(), woss::ResTimeArrTxtDbCreator::createWossDb(), and woss::SspWoa2005DbCreator::createWossDb().

woss_db_debug

bool woss::WossDbCreator::woss_db_debug

protected

WossDb debug flag binded in Tcl. All objects instantiated will have this flag

Referenced by initializeDb().

---

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

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