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

Data behaviour class for SSP database. More...

#include <woss-db.h>

Inheritance diagram for woss::WossSSPDb:
Inheritance graph
Collaboration diagram for woss::WossSSPDb:
Collaboration graph

Public Member Functions

virtual bool insertValue (const Coord &coordinates, const Time &time_value, const SSP &ssp_value)=0
 
virtual SSPgetValue (const Coord &coords, const Time &time, long double ssp_depth_precision) const =0
 

Detailed Description

Data behaviour class for SSP database.

WossSSPDb is the prototype of any SSP dabase in WOSS

See also
SspWoa2005Db

Member Function Documentation

◆ getValue()

virtual SSP * woss::WossSSPDb::getValue ( const Coord coords,
const Time time,
long double  ssp_depth_precision 
) const
pure virtual

Returns a pointer to a heap-created SSP object for given coordinates and date time if both present in the database. User is responsible of pointer's ownership

Parameters
coordsconst reference to a valid Coord object
timeconst reference to a valid Time object
ssp_depth_precisionssp depth precision [m]
Returns
valid SSP if coordinates and time date are found, not valid otherwise

Implemented in woss::SspWoa2005Db.

Referenced by woss::WossDbManager::getAverageSSP(), and woss::WossDbManager::getSSP().

◆ insertValue()

virtual bool woss::WossSSPDb::insertValue ( const Coord coordinates,
const Time time_value,
const SSP ssp_value 
)
pure virtual

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

Parameters
coordinatesconst reference to a valid woss::Coord object
time_valueconst reference to a valid woss::Time object
ssp_valueconst reference to woss::SSP value to be inserted
Returns
true if method was successful, false otherwise

Implemented in woss::SspWoa2005Db.


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