woss::BathyGebcoDbCreator Class Reference

WossDbCreator for the GEBCO bathymetry database. More...

#include <bathymetry-gebco-db-creator.h>

Inheritance diagram for woss::BathyGebcoDbCreator:

Collaboration diagram for woss::BathyGebcoDbCreator:

Public Member Functions
	BathyGebcoDbCreator ()=default
	BathyGebcoDbCreator (const BathyGebcoDbCreator &copy)=default
	BathyGebcoDbCreator (BathyGebcoDbCreator &&tmp)=default
virtual	~BathyGebcoDbCreator () override=default
BathyGebcoDbCreator &	operator= (const BathyGebcoDbCreator &copy)=default
BathyGebcoDbCreator &	operator= (BathyGebcoDbCreator &&tmp)=default
virtual std::unique_ptr< WossDbCreator >	clone () const override
virtual std::unique_ptr< WossDb >	createWossDb () const override
BathyGebcoDbCreator &	setGebcoBathyType (GEBCO_BATHY_TYPE bathy_type)
GEBCO_BATHY_TYPE	getGebcoBathyType () const
Public Member Functions inherited from woss::WossDbCreator
	WossDbCreator ()=default
	WossDbCreator (const WossDbCreator &copy)=default
	WossDbCreator (WossDbCreator &&tmp)=default
virtual	~WossDbCreator ()=default
WossDbCreator &	operator= (const WossDbCreator &copy)=default
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 override

Protected Attributes
GEBCO_BATHY_TYPE	gebco_type = GEBCO_BATHY_TYPE::GEBCO_2D_30_SECONDS_BATHY_TYPE
Protected Attributes inherited from woss::WossDbCreator
bool	debug = false
bool	woss_db_debug = false
std::string	pathname = ""

Detailed Description

WossDbCreator for the GEBCO bathymetry database.

Specialization of WossDbCreator for the GEBCO bathymetry database.

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

Constructor & Destructor Documentation

BathyGebcoDbCreator() [1/3]

woss::BathyGebcoDbCreator::BathyGebcoDbCreator ( )

default

BathyGebcoDbCreator() [2/3]

woss::BathyGebcoDbCreator::BathyGebcoDbCreator ( const BathyGebcoDbCreator &  copy )

default

BathyGebcoDbCreator() [3/3]

woss::BathyGebcoDbCreator::BathyGebcoDbCreator ( BathyGebcoDbCreator &&  tmp )

default

~BathyGebcoDbCreator()

virtual woss::BathyGebcoDbCreator::~BathyGebcoDbCreator ( )

overridevirtualdefault

Member Function Documentation

clone()

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

inlineoverridevirtual

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

Implements woss::WossDbCreator.

createWossDb()

std::unique_ptr< WossDb > BathyGebcoDbCreator::createWossDb ( ) const

overridevirtual

Creates and initialize a BathyGebcoDb object

Returns

a std::unique_ptr to a properly initialized BathyGebcoDb object

Implements woss::WossDbCreator.

References gebco_type, initializeDb(), and woss::WossDbCreator::pathname.

Here is the call graph for this function:

getGebcoBathyType()

GEBCO_BATHY_TYPE woss::BathyGebcoDbCreator::getGebcoBathyType ( ) const

inline

Gets the GEBCO_BATHY_TYPE related to the netcdf db that will be opened

Returns

gebco_type

References gebco_type.

initializeDb()

bool BathyGebcoDbCreator::initializeDb ( WossDb &  woss_db ) const

overrideprotectedvirtual

Initializes the pointed object

Parameters

woss_db

reference to a recently created BathyGebcoDb

Returns

true if the method succeed, false otherwise

Implements woss::WossDbCreator.

References woss::WossDbCreator::initializeDb().

Referenced by createWossDb().

Here is the call graph for this function:

operator=() [1/2]

BathyGebcoDbCreator & woss::BathyGebcoDbCreator::operator= ( BathyGebcoDbCreator &&  tmp )

default

operator=() [2/2]

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

default

setGebcoBathyType()

BathyGebcoDbCreator & woss::BathyGebcoDbCreator::setGebcoBathyType ( GEBCO_BATHY_TYPE  bathy_type )

inline

Sets the GEBCO_BATHY_TYPE related to the netcdf db that will be opened

Parameters

bathy_type

netcdf file format

Returns

reference to *this

References gebco_type.

Member Data Documentation

gebco_type

GEBCO_BATHY_TYPE woss::BathyGebcoDbCreator::gebco_type = GEBCO_BATHY_TYPE::GEBCO_2D_30_SECONDS_BATHY_TYPE

protected

GEBCO version in use

See also

GEBCO_BATHY_TYPE

Referenced by createWossDb(), getGebcoBathyType(), and setGebcoBathyType().

---

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

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