WossDb for NetCDF DECK41 Sediment database. More...

#include <sediment-deck41-db.h>

Inheritance diagram for woss::SedimDeck41Db:

Collaboration diagram for woss::SedimDeck41Db:

Public Member Functions
	SedimDeck41Db (const std::string &name)

virtual	~SedimDeck41Db () override=default

virtual bool	openConnection () override

virtual bool	finalizeConnection () override

virtual bool	closeConnection () override

virtual bool	insertValue (const Coord &coordinates, const Sediment &sediment_value) override

virtual std::unique_ptr< Sediment >	getValue (const CoordZ &coordz) const override

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

Public Member Functions inherited from woss::WossDb
	WossDb (const std::string &name)

virtual	~WossDb ()=default

void	setDbName (const std::string &pathname)

std::string	getDbName () const

void	setDebug (double flag=true)

bool	isUsingDebug () const

virtual bool	isValid () const

Public Member Functions inherited from woss::WossSedimentDb
	WossSedimentDb ()=default

virtual	~WossSedimentDb ()=default

Protected Member Functions
double	calculateAvgDepth (const CoordZVector &coordz_vector) const

Deck41Types	getDeck41TypesFromCoords (const CoordZVector &coordz_vector) const

Deck41Types	getDeck41TypesFromMarsdenCoords (const CoordZVector &coordz_vector) const

Deck41Types	getDeck41TypesFromMarsdenSquare (const CoordZVector &coordz_vector) const

Deck41Types	calculateDeck41Types (const CoordZVector &coordz_vector) const

std::unique_ptr< Sediment >	calculateSediment (const Deck41Types &floor_types, double avg_depth) const

std::unique_ptr< Sediment >	createSediment (int deck41_type, double depth) const

int	getMaxAppereanceFrequencyValue (const FrequencyMap &frequency_map) const

bool	doTestA (const Deck41TypeTests &test) const

bool	doTestB (const Deck41TypeTests &test) const

bool	doTestC (const Deck41TypeTests &test) const

Protected Member Functions inherited from woss::WossDb
PathName	getPathName (const std::string &complete_path) const

Static Protected Member Functions
static SedimWeightMap	initSedimWeightMap ()

Protected Attributes
SedimDeck41CoordDb	sediment_coord_db

SedimDeck41MarsdenDb	sediment_marsden_db

SedimDeck41MarsdenOneDb	sediment_marsden_one_db

Deck41TypeTests	curr_tests_state

Deck41TypeTests	prev_tests_state

Protected Attributes inherited from woss::WossDb
std::string	db_name

bool	debug

Static Protected Attributes
static SedimWeightMap	sediment_weight_map = SedimDeck41Db::initSedimWeightMap()

Friends
class	SedimDeck41DbCreator

Detailed Description

WossDb for NetCDF DECK41 Sediment database.

SedimDeck41Db implements WossDb and WossSedimentDb for NetCDF DECK41 Sediment database. It provides logic to handle the three custom made databases: coordinates, marsden square and marsden coordinates.

Constructor & Destructor Documentation

◆ SedimDeck41Db()

SedimDeck41Db::SedimDeck41Db ( const std::string & name )

SedimDeck41Db constructor

Parameters

name	pathname of database

◆ ~SedimDeck41Db()

virtual woss::SedimDeck41Db::~SedimDeck41Db ( )

overridevirtualdefault

Member Function Documentation

◆ calculateAvgDepth()

double SedimDeck41Db::calculateAvgDepth ( const CoordZVector & coordz_vector ) const

protected

Computes the average depth of a valid CoordZVector for Sediment creation

Parameters

coordz_vector a vector of valid CoordZ

Returns: the average depth of the vector [m]

Referenced by getValue().

◆ calculateDeck41Types()

Deck41Types SedimDeck41Db::calculateDeck41Types ( const CoordZVector & coordz_vector ) const

protected

Gets the Deck41Types of a valid CoordZVector searching in order in: coord db, marsden db, marsden one db. On each search Deck41TypeTests curr_tests_state and prev_tests_state are updated, and based on result conditions, the process stops and returns or goes on to the next database.

Parameters

coordz_vector a vector of valid CoordZ

Returns: the corresponding Deck41Types (main sediment type, second sediment type) of the vector

References curr_tests_state, woss::WossDb::debug, doTestA(), doTestB(), doTestC(), getDeck41TypesFromCoords(), getDeck41TypesFromMarsdenCoords(), getDeck41TypesFromMarsdenSquare(), prev_tests_state, and woss::Deck41TypeTests::updateAllConditions().

Referenced by getValue().

Here is the call graph for this function:

◆ calculateSediment()

std::unique_ptr< Sediment > SedimDeck41Db::calculateSediment	(	const Deck41Types &	floor_types,
		double	avg_depth
	)		const

protected

Creates the corresponding Sediment from the searched Deck41Types returned by calculateDeck41Types

Parameters

floor_types	the Deck41Types pair resulted from the search process
avg_depth	depth value [m] for Sediment calculations

Returns: std::unique_ptr to a Sediment value

References createSediment(), curr_tests_state, woss::WossDb::debug, woss::Deck41TypeTests::getConditionA(), woss::Deck41TypeTests::getConditionB(), woss::Deck41TypeTests::getConditionC(), woss::Deck41TypeTests::getConditionD(), woss::Deck41TypeTests::getConditionE(), woss::Deck41TypeTests::getConditionF(), woss::Singleton< T >::instance(), and sediment_weight_map.

Referenced by getValue().

Here is the call graph for this function:

◆ closeConnection()

bool SedimDeck41Db::closeConnection ( )

overridevirtual

Closes the connection to the three databases provided

Returns: true if method was successful, false otherwise

Implements woss::WossDb.

References woss::WossNetcdfDb::closeConnection(), sediment_coord_db, sediment_marsden_db, and sediment_marsden_one_db.

Here is the call graph for this function:

◆ createSediment()

std::unique_ptr< Sediment > SedimDeck41Db::createSediment	(	int	deck41_type,
		double	depth
	)		const

protected

Creates a Sediment from the DECK41 integer type number

Parameters

deck41_type	DECK41 integer floor type number
depth	depth value [m] for Sediment calculations

Returns: std::unique_ptr to a Sediment value

See also: Deck41TypeTests

References woss::Singleton< T >::instance().

Referenced by calculateSediment().

Here is the call graph for this function:

◆ doTestA()

bool woss::SedimDeck41Db::doTestA ( const Deck41TypeTests & test ) const

inlineprotected

Does Test A on given Deck41TypeTests reference. A positive result means that the search in the databases for a valid Deck41Types is over

Parameters

test	const Deck41TypeTests reference

Returns: true if test succeed, false otherwise

References woss::Deck41TypeTests::getConditionA(), woss::Deck41TypeTests::getConditionB(), woss::Deck41TypeTests::getConditionE(), and woss::Deck41TypeTests::getConditionF().

Referenced by calculateDeck41Types().

Here is the call graph for this function:

◆ doTestB()

bool woss::SedimDeck41Db::doTestB ( const Deck41TypeTests & test ) const

inlineprotected

Does Test B on given Deck41TypeTests reference. A positive result means that the search in the databases for a valid Deck41Types should continue. If next search step fails a Sediment not valid will be returned from the search process

Parameters

test	const Deck41TypeTests reference

Returns: true if test succeed, false otherwise

References woss::Deck41TypeTests::getConditionC(), woss::Deck41TypeTests::getConditionD(), and woss::Deck41TypeTests::getConditionG().

Referenced by calculateDeck41Types().

Here is the call graph for this function:

◆ doTestC()

bool woss::SedimDeck41Db::doTestC ( const Deck41TypeTests & test ) const

inlineprotected

Does Test C on given Deck41TypeTests reference. A positive result means that the search in the databases for a valid Deck41Types is over if the next search step Test A fails

Parameters

test	const Deck41TypeTests reference

Returns: true if test succeed, false otherwise

References woss::Deck41TypeTests::getConditionC(), and woss::Deck41TypeTests::getConditionD().

Referenced by calculateDeck41Types().

Here is the call graph for this function:

◆ finalizeConnection()

virtual bool woss::SedimDeck41Db::finalizeConnection ( )

inlineoverridevirtual

Not allowed

Implements woss::WossDb.

◆ getDeck41TypesFromCoords()

Deck41Types SedimDeck41Db::getDeck41TypesFromCoords ( const CoordZVector & coordz_vector ) const

protected

Gets the Deck41Types of a valid CoordZVector from the SedimDeck41CoordDb database

Parameters

coordz_vector a vector of valid CoordZ

Returns: the corresponding Deck41Types (main sediment type, second sediment type) of the vector

References woss::WossDb::debug, getMaxAppereanceFrequencyValue(), woss::SedimDeck41CoordDb::getSeaFloorType(), and sediment_coord_db.

Referenced by calculateDeck41Types().

Here is the call graph for this function:

◆ getDeck41TypesFromMarsdenCoords()

Deck41Types SedimDeck41Db::getDeck41TypesFromMarsdenCoords ( const CoordZVector & coordz_vector ) const

protected

Gets the Deck41Types of a valid CoordZVector from the SedimDeck41MarsdenDb database

Parameters

coordz_vector a vector of valid CoordZ

Returns: the corresponding Deck41Types (main sediment type, second sediment type) of the vector

References woss::WossDb::debug, getMaxAppereanceFrequencyValue(), woss::SedimDeck41MarsdenOneDb::getSeaFloorType(), and sediment_marsden_one_db.

Referenced by calculateDeck41Types().

Here is the call graph for this function:

◆ getDeck41TypesFromMarsdenSquare()

Deck41Types SedimDeck41Db::getDeck41TypesFromMarsdenSquare ( const CoordZVector & coordz_vector ) const

protected

Gets the Deck41Types of a valid CoordZVector from the SedimDeck41MarsdenOneDb database

Parameters

coordz_vector a vector of valid CoordZ

Returns: the corresponding Deck41Types (main sediment type, second sediment type) of the vector

References woss::WossDb::debug, getMaxAppereanceFrequencyValue(), woss::SedimDeck41MarsdenDb::getSeaFloorType(), and sediment_marsden_db.

Referenced by calculateDeck41Types().

Here is the call graph for this function:

◆ getMaxAppereanceFrequencyValue()

int SedimDeck41Db::getMaxAppereanceFrequencyValue ( const FrequencyMap & frequency_map ) const

protected

Returns the type of the FrequencyMap that has the max number of times of appeareance in a database query result

Parameters

frequency_map const FrequencyMap reference

Returns: DECK41 integer type

Referenced by getDeck41TypesFromCoords(), getDeck41TypesFromMarsdenCoords(), and getDeck41TypesFromMarsdenSquare().

◆ getValue() [1/2]

std::unique_ptr< Sediment > SedimDeck41Db::getValue ( const CoordZ & coordz ) const

overridevirtual

Returns a pointer to a heap-based Sediment for given coordinates and depth, if present in any of the three databases. User is responsible of pointer's ownership

Parameters

coords const reference to a valid CoordZ object

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

Implements woss::WossSedimentDb.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

◆ getValue() [2/2]

std::unique_ptr< Sediment > SedimDeck41Db::getValue ( const CoordZVector & coordz_vector ) const

overridevirtual

Returns a pointer to a heap-based Sediment for given coordinates and depth vector, if at least one set of coordinates is present in any of the three databases. 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

Implements woss::WossSedimentDb.

References calculateAvgDepth(), calculateDeck41Types(), and calculateSediment().

Here is the call graph for this function:

◆ initSedimWeightMap()

SedimWeightMap SedimDeck41Db::initSedimWeightMap ( )

staticprotected

Initializes the static sediment_weight_map

Returns: a SedimWeightMap

◆ insertValue()

bool SedimDeck41Db::insertValue	(	const Coord &	coordinates,
		const Sediment &	sediment_value
	)

overridevirtual

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

Parameters

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

Returns: true if method was successful, false otherwise

Implements woss::WossSedimentDb.

◆ openConnection()

virtual bool woss::SedimDeck41Db::openConnection ( )

inlineoverridevirtual

Not allowed

Implements woss::WossDb.

Friends And Related Symbol Documentation

◆ SedimDeck41DbCreator

friend class SedimDeck41DbCreator

friend

Member Data Documentation

◆ curr_tests_state

Deck41TypeTests woss::SedimDeck41Db::curr_tests_state

mutableprotected

Current iteration Deck41TypeTests

Referenced by calculateDeck41Types(), and calculateSediment().

◆ prev_tests_state

Deck41TypeTests woss::SedimDeck41Db::prev_tests_state

mutableprotected

Previous iteration Deck41TypeTests

Referenced by calculateDeck41Types().

◆ sediment_coord_db

SedimDeck41CoordDb woss::SedimDeck41Db::sediment_coord_db

protected

WossDb handling custom made NetCDF DECK41 database

Referenced by closeConnection(), getDeck41TypesFromCoords(), and woss::SedimDeck41DbCreator::initializeSedimDb().

◆ sediment_marsden_db

SedimDeck41MarsdenDb woss::SedimDeck41Db::sediment_marsden_db

protected

WossDb handling custom made NetCDF DECK41 marsden square database

Referenced by closeConnection(), getDeck41TypesFromMarsdenSquare(), and woss::SedimDeck41DbCreator::initializeSedimDb().

◆ sediment_marsden_one_db

SedimDeck41MarsdenOneDb woss::SedimDeck41Db::sediment_marsden_one_db

protected

WossDb handling custom made NetCDF DECK41 marsden coordinates database

Referenced by closeConnection(), getDeck41TypesFromMarsdenCoords(), and woss::SedimDeck41DbCreator::initializeSedimDb().

◆ sediment_weight_map

SedimWeightMap SedimDeck41Db::sediment_weight_map = SedimDeck41Db::initSedimWeightMap()

staticprotected

Weight map for DECK41 floor type to Sediment conversion

Referenced by calculateSediment().

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

woss/woss_db/sediment-deck41-db.h
woss/woss_db/sediment-deck41-db.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SedimDeck41Db()

◆ ~SedimDeck41Db()

Member Function Documentation

◆ calculateAvgDepth()

◆ calculateDeck41Types()

◆ calculateSediment()

◆ closeConnection()

◆ createSediment()

◆ doTestA()

◆ doTestB()

◆ doTestC()

◆ finalizeConnection()

◆ getDeck41TypesFromCoords()

◆ getDeck41TypesFromMarsdenCoords()

◆ getDeck41TypesFromMarsdenSquare()

◆ getMaxAppereanceFrequencyValue()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ initSedimWeightMap()

◆ insertValue()

◆ openConnection()

Friends And Related Symbol Documentation

◆ SedimDeck41DbCreator

Member Data Documentation

◆ curr_tests_state

◆ prev_tests_state

◆ sediment_coord_db

◆ sediment_marsden_db

◆ sediment_marsden_one_db

◆ sediment_weight_map