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 ()=default
	WossDbCreator (const WossDbCreator &copy)=default
	WossDbCreator (WossDbCreator &&tmp)=default
virtual	~WossDbCreator ()=default
WossDbCreator &	operator= (const WossDbCreator &copy)=default
virtual std::unique_ptr< WossDb >	createWossDb () const =0
virtual std::unique_ptr< WossDbCreator >	clone () const =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 &woss_db) const =0

Protected Attributes
bool	debug = false
bool	woss_db_debug = false
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() [1/3]

woss::WossDbCreator::WossDbCreator ( )

default

Default WossDbCreator creator

Referenced by operator=(), setDbPathName(), setDebug(), setWossDebug(), woss::SspWoa2005DbCreator::SspWoa2005DbCreator(), WossDbCreator(), and WossDbCreator().

WossDbCreator() [2/3]

woss::WossDbCreator::WossDbCreator ( const WossDbCreator & copy )

default

References WossDbCreator().

Here is the call graph for this function:

WossDbCreator() [3/3]

woss::WossDbCreator::WossDbCreator ( WossDbCreator && tmp )

default

References WossDbCreator().

Here is the call graph for this function:

~WossDbCreator()

virtual woss::WossDbCreator::~WossDbCreator ( )

virtualdefault

Member Function Documentation

clone()

virtual std::unique_ptr< WossDbCreator > woss::WossDbCreator::clone ( ) const

pure virtual

Abstract method. Virtual factory method. It is called to clone this WossDbCreator instance. The caller will be the owner of created object, therefore object destruction is his responsibility

Returns

a std::unique_ptr to a properly initialized WossDbCreator object

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

createWossDb()

virtual std::unique_ptr< WossDb > woss::WossDbCreator::createWossDb ( ) const

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 std::unique_ptr 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.

getDbPathName()

std::string woss::WossDbCreator::getDbPathName ( ) const

inline

References pathname.

initializeDb()

bool WossDbCreator::initializeDb ( WossDb & woss_db ) const

protectedpure virtual

Initializes the referenced object

Parameters

woss_db

reference 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::SedimDeck41DbCreator, and woss::SspWoa2005DbCreator.

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::SedimDeck41DbCreator::initializeDb(), and woss::SspWoa2005DbCreator::initializeDb().

Here is the call graph for this function:

isUsingDebug()

bool woss::WossDbCreator::isUsingDebug ( ) const

inline

References debug.

isUsingWossDbDebug()

bool woss::WossDbCreator::isUsingWossDbDebug ( ) const

inline

References woss_db_debug.

operator=()

WossDbCreator & woss::WossDbCreator::operator= ( const WossDbCreator & copy )

default

References WossDbCreator().

Here is the call graph for this function:

setDbPathName()

WossDbCreator & woss::WossDbCreator::setDbPathName ( const std::string & name )

inline

References pathname, and WossDbCreator().

Referenced by WossUnitTest::testResPressureDb(), and WossUnitTest::testResTimeArrDb().

Here is the call graph for this function:

setDebug()

WossDbCreator & woss::WossDbCreator::setDebug ( bool flag )

inline

References debug, and WossDbCreator().

Here is the call graph for this function:

setWossDebug()

WossDbCreator & woss::WossDbCreator::setWossDebug ( bool flag )

inline

References woss_db_debug, and WossDbCreator().

Here is the call graph for this function:

Member Data Documentation

debug

bool woss::WossDbCreator::debug = false

protected

WossDbCreator debug flag binded in Tcl

Referenced by woss::ResPressureBinDbCreator::createWossDb(), woss::ResPressureTxtDbCreator::createWossDb(), woss::ResTimeArrBinDbCreator::createWossDb(), woss::ResTimeArrTxtDbCreator::createWossDb(), isUsingDebug(), and setDebug().

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(), woss::SspWoa2005DbCreator::createWossDb(), getDbPathName(), and setDbPathName().

woss_db_debug

bool woss::WossDbCreator::woss_db_debug = false

protected

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

Referenced by initializeDb(), isUsingWossDbDebug(), and setWossDebug().

---

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