World Ocean Simulation System (WOSS) library
woss::BathyGebcoDbCreator Class Reference

WossDbCreator for the GEBCO bathymetry database. More...

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

Inheritance diagram for woss::BathyGebcoDbCreator:
Inheritance graph
Collaboration diagram for woss::BathyGebcoDbCreator:
Collaboration graph

Public Member Functions

 BathyGebcoDbCreator ()
 
virtual WossDb *const createWossDb ()
 
BathyGebcoDbCreatorsetGebcoBathyType (GEBCO_BATHY_TYPE bathy_type)
 
GEBCO_BATHY_TYPE getGebcoBathyType ()
 
- Public Member Functions inherited from woss::WossDbCreator
 WossDbCreator ()
 
WossDbCreatorsetDebug (bool flag)
 
WossDbCreatorsetWossDebug (bool flag)
 
WossDbCreatorsetDbPathName (const ::std::string &name)
 
bool isUsingDebug () const
 
bool isUsingWossDbDebug () const
 
::std::string getDbPathName () const
 

Protected Member Functions

virtual bool initializeDb (WossDb *const woss_db)
 

Protected Attributes

GEBCO_BATHY_TYPE gebco_type
 
- Protected Attributes inherited from woss::WossDbCreator
bool debug
 
bool woss_db_debug
 
::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()

BathyGebcoDbCreator::BathyGebcoDbCreator ( )

Member Function Documentation

◆ createWossDb()

WossDb *const BathyGebcoDbCreator::createWossDb ( )
virtual

Creates and initialize a BathyGebcoDb object

Returns
a pointer to a properly initialized BathyGebcoDb object

Implements woss::WossDbCreator.

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

Here is the call graph for this function:

◆ getGebcoBathyType()

GEBCO_BATHY_TYPE woss::BathyGebcoDbCreator::getGebcoBathyType ( )
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 *const  woss_db)
protectedvirtual

Initializes the pointed object

Parameters
woss_dbpointer 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:

◆ 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_typenetcdf file format
Returns
reference to *this

References gebco_type.

Member Data Documentation

◆ gebco_type

GEBCO_BATHY_TYPE woss::BathyGebcoDbCreator::gebco_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: