woss::WossSedimentDb Class Reference

Data behaviour class for Sediment database. More...

#include <woss-db.h>

Inheritance diagram for woss::WossSedimentDb:

Collaboration diagram for woss::WossSedimentDb:

Public Member Functions
	WossSedimentDb ()=default
virtual	~WossSedimentDb ()=default
virtual bool	insertValue (const Coord &coordinates, const Sediment &sediment_value)=0
virtual std::unique_ptr< Sediment >	getValue (const CoordZ &coords) const =0
virtual std::unique_ptr< Sediment >	getValue (const CoordZVector &coordz_vector) const =0

Detailed Description

Data behaviour class for Sediment database.

WossSedimentDb is the prototype of any Sediment dabase in WOSS

See also

SedimDeck41Db

Constructor & Destructor Documentation

WossSedimentDb()

woss::WossSedimentDb::WossSedimentDb ( )

default

~WossSedimentDb()

virtual woss::WossSedimentDb::~WossSedimentDb ( )

virtualdefault

Member Function Documentation

getValue() [1/2]

virtual std::unique_ptr< Sediment > woss::WossSedimentDb::getValue ( const CoordZ &  coords ) const

pure virtual

Returns a std::unique_ptr to a heap-created Sediment value for given coordinates and depth, if present in the database. User is responsible of pointer's ownership

Parameters

coords

const reference to a valid CoordZ object

Returns

std::unique_ptr to a valid Sediment if coordinates are found, not valid otherwise

Implemented in woss::SedimDeck41Db.

getValue() [2/2]

virtual std::unique_ptr< Sediment > woss::WossSedimentDb::getValue ( const CoordZVector &  coordz_vector ) const

pure virtual

Returns a std::unique_ptr to a heap-created Sediment value for given coordinates and depth vector, if at least one set of coordinates is present in the database. User is responsible of pointer's ownership

Parameters

coordz_vector

const reference to a valid CoordZ vector

Returns

std::unique_ptr to a valid Sediment if at least one set of coordinates is found, not valid otherwise

Implemented in woss::SedimDeck41Db.

insertValue()

virtual bool woss::WossSedimentDb::insertValue ( const Coord &  coordinates, const Sediment &  sediment_value  )

pure virtual

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

Parameters

coordinates	const reference to a valid woss::Coord object
bathymetry_value	const reference to woss::Sediment value to be inserted

Returns

true if method was successful, false otherwise

Implemented in woss::SedimDeck41Db.

---

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

• woss/woss_db/woss-db.h