World Ocean Simulation System (WOSS) library
woss::WossBathymetryDb Class Referenceabstract

Data behaviour class for bathymetry database. More...

#include <woss-db.h>

Inheritance diagram for woss::WossBathymetryDb:
Inheritance graph
Collaboration diagram for woss::WossBathymetryDb:
Collaboration graph

Public Member Functions

virtual bool insertValue (const Coord &coordinates, const Bathymetry &bathymetry_value)=0
 
virtual Bathymetry getValue (const Coord &coords) const =0
 

Detailed Description

Data behaviour class for bathymetry database.

WossBathymetryDb is the prototype of any bathymetry dabase in WOSS

See also
BathyGebcoDb

Member Function Documentation

◆ getValue()

virtual Bathymetry woss::WossBathymetryDb::getValue ( const Coord coords) const
pure virtual

Returns the positive depth value ( woss::Bathymetry ) for given coordinates, if present in the database

Parameters
coordsconst reference to a valid Coord object
Returns
positive depth value [m] if coordinates are found, HUGE_VAL otherwise

Implemented in woss::BathyGebcoDb, and woss::BathyUtmCsvDb.

Referenced by woss::WossDbManager::getBathymetry().

◆ insertValue()

virtual bool woss::WossBathymetryDb::insertValue ( const Coord coordinates,
const Bathymetry &  bathymetry_value 
)
pure virtual

Inserts the given woss::Bathymetry value in the database for given coordinates

Parameters
coordinatesconst reference to a valid woss::Coord object
bathymetry_valueconst reference to woss::Bathymetry value to be inserted
Returns
true if method was successful, false otherwise

Implemented in woss::BathyGebcoDb, and woss::BathyUtmCsvDb.


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