Abstraction layer for database and data manipulation. More...

#include <woss-db-manager.h>

Collaboration diagram for woss::WossDbManager:

Classes
class	BearingOperator
	Bearing operator function object. More...
class	RangeOperator
	Range operator function object. More...

Public Types
using	CCBathymetry = CustomDataContainer< Coord, BearingOperator, RangeOperator, Bathymetry >
using	CCSSP = CustomDataTimeContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<SSP> >
using	CCSediment = CustomDataContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<Sediment> >
using	CCAltimetry = CustomDataContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<Altimetry> >

Public Member Functions
	WossDbManager ()
	WossDbManager (const WossDbManager &instance)=default
	WossDbManager (WossDbManager &&instance)=default
WossDbManager &	operator= (const WossDbManager &instance)=default
WossDbManager &	operator= (WossDbManager &&instance)=default
virtual	~WossDbManager ()=default
virtual std::unique_ptr< Altimetry >	getAltimetry (const CoordZ &tx, const CoordZ &rx) const
virtual std::unique_ptr< Sediment >	getSediment (const CoordZ &tx, const CoordZ &rx) const
virtual std::unique_ptr< Sediment >	getSediment (const CoordZ &tx, const CoordZVector &rx_coordz_vector) const
virtual Bathymetry	getBathymetry (const Coord &tx, const Coord &rx) const
virtual void	getBathymetry (const Coord &tx, CoordZVector &rx_coordz_vector) const
virtual std::unique_ptr< SSP >	getSSP (const Coord &tx, const Coord &rx, const Time &time, long double ssp_depth_precision=SSP_CUSTOM_DEPTH_PRECISION) const
virtual std::unique_ptr< SSP >	getAverageSSP (const Coord &tx, const Coord &rx, const Time &time_start, const Time &time_end, int max_time_values, long double ssp_depth_precision=SSP_CUSTOM_DEPTH_PRECISION) const
virtual std::unique_ptr< TimeArr >	getTimeArr (const CoordZ &coord_tx, const CoordZ &coord_rx, const double frequency, const Time &time_value) const
virtual void	insertTimeArr (const CoordZ &coord_tx, const CoordZ &coord_rx, const double frequency, const Time &time_value, const TimeArr &channel) const
virtual std::unique_ptr< Pressure >	getPressure (const CoordZ &coord_tx, const CoordZ &coord_rx, const double frequency, const Time &time_value) const
virtual void	insertPressure (const CoordZ &coord_tx, const CoordZ &coord_rx, const double frequency, const Time &time_value, const Pressure &pressure) const
WossDbManager &	setBathymetryDb (std::unique_ptr< WossBathymetryDb > ptr)
WossDbManager &	setSedimentDb (std::unique_ptr< WossSedimentDb > ptr)
WossDbManager &	setSSPDb (std::unique_ptr< WossSSPDb > ptr)
WossDbManager &	setResTimeArrDb (std::unique_ptr< WossResTimeArrDb > ptr)
WossDbManager &	setResPressureDb (std::unique_ptr< WossResPressDb > ptr)
bool	setCustomAltimetry (const Altimetry &altimetry, const Coord &tx_coord=CCAltimetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCAltimetry::DB_CDATA_ALL_INNER_KEYS)
std::unique_ptr< Altimetry >	getCustomAltimetry (const Coord &tx_coord=CCAltimetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCAltimetry::DB_CDATA_ALL_INNER_KEYS) const
WossDbManager &	eraseCustomAltimetry (const Coord &tx_coord=CCAltimetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCAltimetry::DB_CDATA_ALL_INNER_KEYS)
bool	setCustomSediment (const Sediment &sediment, const Coord &tx_coord=CCSediment::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSediment::DB_CDATA_ALL_INNER_KEYS)
bool	setCustomSediment (const std::string &sediment_string, const Coord &txCoord=CCSediment::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSediment::DB_CDATA_ALL_INNER_KEYS)
std::unique_ptr< Sediment >	getCustomSediment (const Coord &tx_coord=CCSediment::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSediment::DB_CDATA_ALL_INNER_KEYS) const
WossDbManager &	eraseCustomSediment (const Coord &tx_coord=CCSediment::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSediment::DB_CDATA_ALL_INNER_KEYS)
bool	setCustomSSP (const SSP &ssp, const Coord &tx_coord=CCSSP::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSSP::DB_CDATA_ALL_INNER_KEYS, const Time &time_value=CCSSP::DB_CDATA_ALL_TIME_KEYS)
bool	setCustomSSP (const std::string &sspString, const Coord &txCoord=CCSSP::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSSP::DB_CDATA_ALL_INNER_KEYS, const Time &time_value=CCSSP::DB_CDATA_ALL_TIME_KEYS)
virtual bool	importCustomSSP (const std::string &filename, const Time &=CCSSP::DB_CDATA_ALL_TIME_KEYS, const Coord &tx_coord=CCSSP::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSSP::DB_CDATA_ALL_MEDIUM_KEYS)
std::unique_ptr< SSP >	getCustomSSP (const Coord &tx_coord=CCSSP::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSSP::DB_CDATA_ALL_INNER_KEYS, const Time &time_value=CCSSP::DB_CDATA_ALL_TIME_KEYS) const
WossDbManager &	eraseCustomSSP (const Coord &tx_coord=CCSSP::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCSSP::DB_CDATA_ALL_INNER_KEYS, const Time &time_value=CCSSP::DB_CDATA_ALL_TIME_KEYS)
bool	setCustomBathymetry (const Bathymetry &bathymetry, const Coord &tx_coord=CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCBathymetry::DB_CDATA_ALL_INNER_KEYS)
bool	setCustomBathymetry (const std::string &bathyLine, const Coord &tx_coord=CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS)
virtual bool	importCustomBathymetry (const std::string &filename, const Coord &tx_coord=CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS)
Bathymetry	getCustomBathymetry (const Coord &tx_coord=CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCBathymetry::DB_CDATA_ALL_INNER_KEYS) const
WossDbManager &	eraseCustomBathymetry (const Coord &tx_coord=CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, double bearing=CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS, double range=CCBathymetry::DB_CDATA_ALL_INNER_KEYS)
WossDbManager &	setDebug (bool flag)
bool	getDebug () const

Protected Member Functions
virtual bool	closeAllConnections ()
virtual void	updateDebugFlag ()

Protected Attributes
std::unique_ptr< WossBathymetryDb >	bathymetry_db
std::unique_ptr< WossSedimentDb >	sediment_db
std::unique_ptr< WossSSPDb >	ssp_db
std::unique_ptr< WossResTimeArrDb >	results_arrivals_db
std::unique_ptr< WossResPressDb >	results_pressure_db
bool	debug
CCBathymetry	ccbathy_map
CCSediment	ccsediment_map
CCSSP	ccssp_map
CCAltimetry	ccaltimetry_map

Detailed Description

Abstraction layer for database and data manipulation.

WossDbManager has the exclusive handling of all databases involved. No other object can access directly to a WossDb entity. Thanks to the abstraction provided, WossDbManager can perform arithmetic and other data manipulation. It should be used with woss::Singleton for safety reasons. ( e.g. woss::Singleton<woss::WossDbManager> ) WossDbManager also provides a way to generate environmental data on the fly. Providing a generator coordinate and a set of bearing and ranges, the user can create all sort of polygon where the given environmental data is valid.

See also: setCustom* methods, command

Member Typedef Documentation

◆ CCAltimetry

using woss::WossDbManager::CCAltimetry = CustomDataContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<Altimetry> >

◆ CCBathymetry

using woss::WossDbManager::CCBathymetry = CustomDataContainer< Coord, BearingOperator, RangeOperator, Bathymetry >

◆ CCSediment

using woss::WossDbManager::CCSediment = CustomDataContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<Sediment> >

◆ CCSSP

using woss::WossDbManager::CCSSP = CustomDataTimeContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<SSP> >

Constructor & Destructor Documentation

◆ WossDbManager() [1/3]

WossDbManager::WossDbManager ( )

Default constructor

References bathymetry_db, ccaltimetry_map, ccbathy_map, ccsediment_map, ccssp_map, debug, results_arrivals_db, results_pressure_db, sediment_db, ssp_db, and updateDebugFlag().

Referenced by eraseCustomAltimetry(), eraseCustomBathymetry(), eraseCustomSediment(), eraseCustomSSP(), operator=(), operator=(), setBathymetryDb(), setDebug(), setResPressureDb(), setResTimeArrDb(), setSedimentDb(), setSSPDb(), WossDbManager(), and WossDbManager().

Here is the call graph for this function:

◆ WossDbManager() [2/3]

woss::WossDbManager::WossDbManager ( const WossDbManager & instance )

default

References WossDbManager().

Here is the call graph for this function:

◆ WossDbManager() [3/3]

woss::WossDbManager::WossDbManager ( WossDbManager && instance )

default

References WossDbManager().

Here is the call graph for this function:

◆ ~WossDbManager()

virtual woss::WossDbManager::~WossDbManager ( )

virtualdefault

Destructor. It deletes all pointers involved. Derived classes don't have to do it

Member Function Documentation

◆ closeAllConnections()

bool WossDbManager::closeAllConnections ( )

protectedvirtual

Closes all connections of owned databases

References bathymetry_db, woss::WossDb::closeConnection(), results_arrivals_db, results_pressure_db, sediment_db, and ssp_db.

Here is the call graph for this function:

◆ eraseCustomAltimetry()

WossDbManager & woss::WossDbManager::eraseCustomAltimetry	(	const Coord &	tx_coord = CCAltimetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCAltimetry::DB_CDATA_ALL_INNER_KEYS )

inline

Erases the custom Altimetry for given parameters

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: reference to *this

References ccaltimetry_map, and WossDbManager().

Referenced by WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ eraseCustomBathymetry()

WossDbManager & woss::WossDbManager::eraseCustomBathymetry	(	const Coord &	tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCBathymetry::DB_CDATA_ALL_INNER_KEYS )

inline

Erases the custom Bathymetry for given parameters

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: reference to *this

References ccbathy_map, and WossDbManager().

Here is the call graph for this function:

◆ eraseCustomSediment()

WossDbManager & woss::WossDbManager::eraseCustomSediment	(	const Coord &	tx_coord = CCSediment::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSediment::DB_CDATA_ALL_INNER_KEYS )

inline

Erases the custom Sediment for given parameters

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: reference to *this

References ccsediment_map, and WossDbManager().

Here is the call graph for this function:

◆ eraseCustomSSP()

WossDbManager & woss::WossDbManager::eraseCustomSSP	(	const Coord &	tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
		const Time &	time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS )

inline

Erases the custom SSP for given parameters

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]
time_value	const reference to a valid Time object

Returns: reference to *this

References ccssp_map, and WossDbManager().

Here is the call graph for this function:

◆ getAltimetry()

std::unique_ptr< Altimetry > WossDbManager::getAltimetry	(	const CoordZ &	tx,
		const CoordZ &	rx ) const

virtual

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

Parameters

coords const reference to a valid CoordZ object

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

References ccaltimetry_map, woss::DefHandler::createAltimetry(), woss::Altimetry::createNotValid(), debug, and woss::Singleton< DefHandler >::instance().

Here is the call graph for this function:

◆ getAverageSSP()

std::unique_ptr< SSP > WossDbManager::getAverageSSP	(	const Coord &	tx,
		const Coord &	rx,
		const Time &	time_start,
		const Time &	time_end,
		int	max_time_values,
		long double	ssp_depth_precision = SSP_CUSTOM_DEPTH_PRECISION ) const

virtual

Returns a std::unique_ptr to a heap-created average SSP for given coordinates, start and end time date if they are present in the database. User is responsible of pointer's ownership

Parameters

coords	const reference to a valid Coord object
time_start	const reference to a valid Time object
time_end	const reference to a valid Time object
max_time_values	total number of Time to take between time_start and time_end
ssp_depth_precision	returned SSP's depth precision

Returns: a std::unique_ptr to a valid SSP if coordinates and both time date are found, not valid otherwise

References ccssp_map, woss::DefHandler::createSSP(), woss::Singleton< DefHandler >::instance(), and ssp_db.

Here is the call graph for this function:

◆ getBathymetry() [1/2]

Bathymetry WossDbManager::getBathymetry	(	const Coord &	tx,
		const Coord &	rx ) const

virtual

Returns the positive depth value ( bathymetry ) of given coordinates, if present in the database

Parameters

coords const reference to a valid Coord object

Returns: positive depth value [m] if coordinates are found, HUGE_VAL otherwise

References bathymetry_db, ccbathy_map, and debug.

Referenced by getBathymetry().

◆ getBathymetry() [2/2]

void WossDbManager::getBathymetry	(	const Coord &	tx,
		CoordZVector &	rx_coordz_vector ) const

virtual

Sets the positive depth for each CoordZ present in the vector, HUGE_VAL is set if coordinates are not present in the database

Parameters

coords reference to a CoordZVector

References getBathymetry().

Here is the call graph for this function:

◆ getCustomAltimetry()

std::unique_ptr< Altimetry > woss::WossDbManager::getCustomAltimetry	(	const Coord &	tx_coord = CCAltimetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCAltimetry::DB_CDATA_ALL_INNER_KEYS ) const

inline

Gets the custom Altimetry for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: std::unique_ptr to an Altimetry value. The object will be not valid if the input is not found

References ccaltimetry_map, woss::Altimetry::createNotValid(), and woss::Singleton< DefHandler >::instance().

Referenced by WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ getCustomBathymetry()

Bathymetry woss::WossDbManager::getCustomBathymetry	(	const Coord &	tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCBathymetry::DB_CDATA_ALL_INNER_KEYS ) const

inline

Gets the custom Bathymetry for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: std::unique_ptr to an Altimetry value. The object will be not valid if the input is not found

References ccbathy_map.

Referenced by WossUnitTest::testWossDbManager().

◆ getCustomSediment()

std::unique_ptr< Sediment > woss::WossDbManager::getCustomSediment	(	const Coord &	tx_coord = CCSediment::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSediment::DB_CDATA_ALL_INNER_KEYS ) const

inline

Gets the custom Sediment for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: std::unique_ptr to a Sediment value. The object will be not valid if the input is not found

References ccsediment_map, and woss::Singleton< DefHandler >::instance().

Referenced by WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ getCustomSSP()

std::unique_ptr< SSP > woss::WossDbManager::getCustomSSP	(	const Coord &	tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
		const Time &	time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS ) const

inline

Gets the custom SSP for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]
time_value	const reference to a valid Time object

Returns: std::unique_ptr to an SSP value. The object will be not valid if the input is not found

References ccssp_map, and woss::Singleton< DefHandler >::instance().

Referenced by WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ getDebug()

bool woss::WossDbManager::getDebug ( ) const

inline

References debug.

◆ getPressure()

std::unique_ptr< Pressure > WossDbManager::getPressure	(	const CoordZ &	coord_tx,
		const CoordZ &	coord_rx,
		const double	frequency,
		const Time &	time_value ) const

virtual

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

Parameters

coord_tx	const reference to a valid CoordZ object
coord_rx	const reference to a valid CoordZ object
frequency	used frequency [hz]
time_value	const reference to a valid Time object

Returns: std::unique_ptr to a valid Pressure if parameters are found, not valid otherwise

References woss::Pressure::createNotValid(), woss::Singleton< DefHandler >::instance(), and results_pressure_db.

Here is the call graph for this function:

◆ getSediment() [1/2]

std::unique_ptr< Sediment > WossDbManager::getSediment	(	const CoordZ &	tx,
		const CoordZ &	rx ) const

virtual

Returns a std::unique_ptr to a heap-created Sediment value for given coordinates and depth, if present in the Sediment 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

References ccsediment_map, woss::DefHandler::createSediment(), debug, woss::Singleton< DefHandler >::instance(), and sediment_db.

Referenced by getSediment().

Here is the call graph for this function:

◆ getSediment() [2/2]

std::unique_ptr< Sediment > WossDbManager::getSediment	(	const CoordZ &	tx,
		const CoordZVector &	rx_coordz_vector ) const

virtual

Returns the std::unique_ptr to a Sediment value of given coordinates and depth vector, if at least one set of coordinates is present in the Sediment 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

References ccsediment_map, woss::DefHandler::createSediment(), debug, getSediment(), woss::Singleton< DefHandler >::instance(), and sediment_db.

Here is the call graph for this function:

◆ getSSP()

std::unique_ptr< SSP > WossDbManager::getSSP	(	const Coord &	tx,
		const Coord &	rx,
		const Time &	time,
		long double	ssp_depth_precision = SSP_CUSTOM_DEPTH_PRECISION ) const

virtual

Returns the SSP value of given coordinates and date time if both present in the database. User is responsible of pointer's ownership

Parameters

coords	const reference to a valid Coord object
time	const reference to a valid Time object
ssp_depth_precision	ssp depth precision [m]

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

References ccssp_map, woss::DefHandler::createSSP(), woss::Singleton< DefHandler >::instance(), and ssp_db.

Here is the call graph for this function:

◆ getTimeArr()

std::unique_ptr< TimeArr > WossDbManager::getTimeArr	(	const CoordZ &	coord_tx,
		const CoordZ &	coord_rx,
		const double	frequency,
		const Time &	time_value ) const

virtual

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

Parameters

coord_tx	const reference to a valid CoordZ object
coord_rx	const reference to a valid CoordZ object
frequency	used frequency [hz]
time_value	const reference to a valid Time object

Returns: std::unique_ptr to a valid TimeArr if parameters are found, not valid otherwise

References woss::TimeArr::createNotValid(), woss::Singleton< DefHandler >::instance(), and results_arrivals_db.

Here is the call graph for this function:

◆ importCustomBathymetry()

bool WossDbManager::importCustomBathymetry	(	const std::string &	filename,
		const Coord &	tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS )

virtual

Imports a CustomBathymetry from file. The file has to be a two column format: Range [m] Depth [m]

Parameters

filename	const reference to a string
tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]

Returns: true if import was successful, false otherwise

References ccbathy_map, and debug.

◆ importCustomSSP()

bool WossDbManager::importCustomSSP	(	const std::string &	filename,
		const Time &	time = CCSSP::DB_CDATA_ALL_TIME_KEYS,
		const Coord &	tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS )

virtual

Imports a CustomSSP from file.
File format:

first line: type name.
second line: latitude for depth and pressure correction purposes
third line: longitude for depth and pressure correction purposes

Following format depends on type name:

"SSP" : three columns. range [m] | depth [m] | sound speed [m/s]
"FULL" : six columns. range [m] | depth [m] | temperature [C°] | salinity [ppu] | pressure [bar] | sound speed [m/s]
"TEMPERATURE_SALINITY_PRESSURE" : four columns. range [m] | temperature [C°] | salinity [ppu] | pressure [bar]
"DEPTH_TEMPERATURE_SALINITY" : four columns. range [m] | depth [m] | temperature [C°] | salinity [ppu]

Parameters

filename	const reference to a string
time	const reference to a valid Time object
tx_coord	const reference to a valid Coord object (originator coordinates)
bearing	bearing value [radians]

Returns: true is import was completed succesfully, false otherwise

References ccssp_map, woss::CustomDataTimeContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr< SSP > >::DB_CDATA_ALL_INNER_KEYS, debug, and woss::Singleton< DefHandler >::instance().

Here is the call graph for this function:

◆ insertPressure()

void WossDbManager::insertPressure	(	const CoordZ &	coord_tx,
		const CoordZ &	coord_rx,
		const double	frequency,
		const Time &	time_value,
		const Pressure &	pressure ) const

virtual

Inserts the given Pressure value in the database at given frequency, transmitter and receiver coordinates

Parameters

coord_tx	const reference to a valid CoordZ object
coord_rx	const reference to a valid CoordZ object
frequency	used frequency [hz]
time_value	const reference to a valid Time object
channel	computed Pressure

References results_pressure_db.

◆ insertTimeArr()

void WossDbManager::insertTimeArr	(	const CoordZ &	coord_tx,
		const CoordZ &	coord_rx,
		const double	frequency,
		const Time &	time_value,
		const TimeArr &	channel ) const

virtual

Inserts a given TimeArr value in the database at given frequency, transmitter and receiver coordinates

Parameters

coord_tx	const reference to a valid CoordZ object
coord_rx	const reference to a valid CoordZ object
frequency	used frequency [hz]
time_value	const reference to a valid Time object
channel	computed TimeArr

References results_arrivals_db.

◆ operator=() [1/2]

WossDbManager & woss::WossDbManager::operator= ( const WossDbManager & instance )

default

References WossDbManager().

Here is the call graph for this function:

◆ operator=() [2/2]

WossDbManager & woss::WossDbManager::operator= ( WossDbManager && instance )

default

References WossDbManager().

Here is the call graph for this function:

◆ setBathymetryDb()

WossDbManager & woss::WossDbManager::setBathymetryDb ( std::unique_ptr< WossBathymetryDb > ptr )

inline

Initializes the bathymetry database pointer. WossDbManager takes the ownership of the Db.

Parameters

ptr	valid std::unique_ptr WossBathymetryDb

Returns: reference to *this

References bathymetry_db, and WossDbManager().

Here is the call graph for this function:

◆ setCustomAltimetry()

bool woss::WossDbManager::setCustomAltimetry	(	const Altimetry &	altimetry,
		const Coord &	tx_coord = CCAltimetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCAltimetry::DB_CDATA_ALL_INNER_KEYS )

inline

Sets the custom Altimetry for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: true if method succed, false otherwise

References ccaltimetry_map, and woss::Altimetry::clone().

Referenced by WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ setCustomBathymetry() [1/2]

bool woss::WossDbManager::setCustomBathymetry	(	const Bathymetry &	bathymetry,
		const Coord &	tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCBathymetry::DB_CDATA_ALL_INNER_KEYS )

inline

Sets the custom Bathymetry for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: if insertion succeed, the function returns a nullptr pointer, that needs to be initialized. if an object was already instantiated, the function returns the pointer to it;

References ccbathy_map.

Referenced by setCustomBathymetry(), and WossUnitTest::testWossDbManager().

◆ setCustomBathymetry() [2/2]

bool WossDbManager::setCustomBathymetry	(	const std::string &	bathyLine,
		const Coord &	tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS )

Reads the input std::string and converts it into a custom woss::Bathymetry object and binds it to the input geometry

Parameters

bathyLine	bathymetry in string format. syntax: tot_ranges\|range_1[m]\|dept_1[n]\|....\|range_final[m]\|depth_final[m]
txCoord	the geometry originating geographical coordinates
bearing	the geometry bearing [radians]

Returns: true if successful, false otherwise

References debug, and setCustomBathymetry().

Here is the call graph for this function:

◆ setCustomSediment() [1/2]

bool woss::WossDbManager::setCustomSediment	(	const Sediment &	sediment,
		const Coord &	tx_coord = CCSediment::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSediment::DB_CDATA_ALL_INNER_KEYS )

inline

Sets the custom Sediment for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]

Returns: if insertion succeed, the function returns a nullptr pointer, that needs to be initialized. if an object was already instantiated, the function returns the pointer to it;

References ccsediment_map, and woss::Sediment::clone().

Referenced by setCustomSediment(), and WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ setCustomSediment() [2/2]

bool WossDbManager::setCustomSediment	(	const std::string &	sediment_string,
		const Coord &	txCoord = CCSediment::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSediment::DB_CDATA_ALL_INNER_KEYS )

Converts the input :std::string into a woss::Sediment object and binds it to the designed geometry.

Parameters

sediment_string	SSP in string format. syntax: Sed_typename\|SSP[m/s]\|vel_c[m/s]\|vel_s[m/s]\|dens[g/cm^3]\|att_c[db/wavelength]\|att_s[db/wavelength]\|bottom_depth[m]
txCoord	the geometry originating geographical coordinates
bearing	the geometry bearing [radians]
range	the geometry range

Returns: true if successful, false otherwise

References woss::DefHandler::createSediment(), debug, woss::Singleton< DefHandler >::instance(), and setCustomSediment().

Here is the call graph for this function:

◆ setCustomSSP() [1/2]

bool woss::WossDbManager::setCustomSSP	(	const SSP &	ssp,
		const Coord &	tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
		const Time &	time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS )

inline

Sets the custom SSP for given generator Coord

Parameters

tx_coord	const reference to a valid Coord (generator coordinates)
bearing	bearing value [radians]
range	range value [m]
time_value	const reference to a valid Time object

Returns: if insertion succeed, the function returns a nullptr pointer, that needs to be initialized. if an object was already instantiated, the function returns the pointer to it;

References ccssp_map, and woss::SSP::clone().

Referenced by setCustomSSP(), and WossUnitTest::testWossDbManager().

Here is the call graph for this function:

◆ setCustomSSP() [2/2]

bool WossDbManager::setCustomSSP	(	const std::string &	sspString,
		const Coord &	txCoord = CCSSP::DB_CDATA_ALL_OUTER_KEYS,
		double	bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS,
		double	range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
		const Time &	time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS )

Converts the input std::string into a custom woss::SSP object and assign it to the designed geometry and simulation time validity.

Parameters

sspString	SSP in string format. syntax: tot_values\|depth_1[m]\|SSP[m/s]\|....\|depth_final[m]\|SSP_final[m/s]
txCoord	the geometry originating geographical coordinates
bearing	the geometry bearing [radians]
range	the geometry range
time_value	the geometry time evolution step

Returns: true if successful, false otherwise

References woss::DefHandler::createSSP(), debug, woss::Singleton< DefHandler >::instance(), and setCustomSSP().

Here is the call graph for this function:

◆ setDebug()

WossDbManager & woss::WossDbManager::setDebug ( bool flag )

inline

References debug, updateDebugFlag(), and WossDbManager().

Here is the call graph for this function:

◆ setResPressureDb()

WossDbManager & woss::WossDbManager::setResPressureDb ( std::unique_ptr< WossResPressDb > ptr )

inline

Initializes the Pressure database pointer WossDbManager takes the ownership of the Db.

Parameters

ptr	std::unique_ptr to a valid WossResPressDb

Returns: reference to *this

References results_pressure_db, and WossDbManager().

Here is the call graph for this function:

◆ setResTimeArrDb()

WossDbManager & woss::WossDbManager::setResTimeArrDb ( std::unique_ptr< WossResTimeArrDb > ptr )

inline

Initializes the TimeArr database pointer WossDbManager takes the ownership of the Db.

Parameters

ptr	std::unique_ptr to a valid WossResTimeArrDb

Returns: reference to *this

References results_arrivals_db, and WossDbManager().

Here is the call graph for this function:

◆ setSedimentDb()

WossDbManager & woss::WossDbManager::setSedimentDb ( std::unique_ptr< WossSedimentDb > ptr )

inline

Initializes the Sediment database pointer. WossDbManager takes the ownership of the Db.

Parameters

ptr	std::unique_ptr to a valid WossSedimentDb

Returns: reference to *this

References sediment_db, and WossDbManager().

Here is the call graph for this function:

◆ setSSPDb()

WossDbManager & woss::WossDbManager::setSSPDb ( std::unique_ptr< WossSSPDb > ptr )

inline

Initializes the SSP database pointer WossDbManager takes the ownership of the Db.

Parameters

ptr	std::unique_ptr to a valid WossSSPDb

Returns: reference to *this

References ssp_db, and WossDbManager().

Here is the call graph for this function:

◆ updateDebugFlag()

void WossDbManager::updateDebugFlag ( )

protectedvirtual

References ccaltimetry_map, ccbathy_map, ccsediment_map, ccssp_map, and debug.

Referenced by setDebug(), and WossDbManager().

Member Data Documentation

◆ bathymetry_db

std::unique_ptr<WossBathymetryDb> woss::WossDbManager::bathymetry_db

protected

Bathymetry database pointer

Referenced by closeAllConnections(), getBathymetry(), setBathymetryDb(), and WossDbManager().

◆ ccaltimetry_map

CCAltimetry woss::WossDbManager::ccaltimetry_map

protected

CustomAltimetry containter for user-given generator CoordZ

Referenced by eraseCustomAltimetry(), getAltimetry(), getCustomAltimetry(), setCustomAltimetry(), updateDebugFlag(), and WossDbManager().

◆ ccbathy_map

CCBathymetry woss::WossDbManager::ccbathy_map

protected

CustomBathymetry containter for user-given generator CoordZ

Referenced by eraseCustomBathymetry(), getBathymetry(), getCustomBathymetry(), importCustomBathymetry(), setCustomBathymetry(), updateDebugFlag(), and WossDbManager().

◆ ccsediment_map

CCSediment woss::WossDbManager::ccsediment_map

protected

custom Sediment containter for user-given generator CoordZ

Referenced by eraseCustomSediment(), getCustomSediment(), getSediment(), getSediment(), setCustomSediment(), updateDebugFlag(), and WossDbManager().

◆ ccssp_map

CCSSP woss::WossDbManager::ccssp_map

protected

CustomSSP containter for user-given generator CoordZ

Referenced by eraseCustomSSP(), getAverageSSP(), getCustomSSP(), getSSP(), importCustomSSP(), setCustomSSP(), updateDebugFlag(), and WossDbManager().

◆ debug

bool woss::WossDbManager::debug

protected

Debug flag

Referenced by getAltimetry(), getBathymetry(), getDebug(), getSediment(), getSediment(), importCustomBathymetry(), importCustomSSP(), setCustomBathymetry(), setCustomSediment(), setCustomSSP(), setDebug(), updateDebugFlag(), and WossDbManager().

◆ results_arrivals_db

std::unique_ptr<WossResTimeArrDb> woss::WossDbManager::results_arrivals_db

protected

TimeArr database pointer

Referenced by closeAllConnections(), getTimeArr(), insertTimeArr(), setResTimeArrDb(), and WossDbManager().

◆ results_pressure_db

std::unique_ptr<WossResPressDb> woss::WossDbManager::results_pressure_db

protected

Pressure database pointer

Referenced by closeAllConnections(), getPressure(), insertPressure(), setResPressureDb(), and WossDbManager().

◆ sediment_db

std::unique_ptr<WossSedimentDb> woss::WossDbManager::sediment_db

protected

Sediment database pointer

Referenced by closeAllConnections(), getSediment(), getSediment(), setSedimentDb(), and WossDbManager().

◆ ssp_db

std::unique_ptr<WossSSPDb> woss::WossDbManager::ssp_db

protected

SSP database pointer

Referenced by closeAllConnections(), getAverageSSP(), getSSP(), setSSPDb(), and WossDbManager().

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

woss/woss_db/woss-db-manager.h
woss/woss_db/woss-db-manager.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CCAltimetry

◆ CCBathymetry

◆ CCSediment

◆ CCSSP

Constructor & Destructor Documentation

◆ WossDbManager() [1/3]

◆ WossDbManager() [2/3]

◆ WossDbManager() [3/3]

◆ ~WossDbManager()

Member Function Documentation

◆ closeAllConnections()

◆ eraseCustomAltimetry()

◆ eraseCustomBathymetry()

◆ eraseCustomSediment()

◆ eraseCustomSSP()

◆ getAltimetry()

◆ getAverageSSP()

◆ getBathymetry() [1/2]

◆ getBathymetry() [2/2]

◆ getCustomAltimetry()

◆ getCustomBathymetry()

◆ getCustomSediment()

◆ getCustomSSP()

◆ getDebug()

◆ getPressure()

◆ getSediment() [1/2]

◆ getSediment() [2/2]

◆ getSSP()

◆ getTimeArr()

◆ importCustomBathymetry()

◆ importCustomSSP()

◆ insertPressure()

◆ insertTimeArr()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setBathymetryDb()

◆ setCustomAltimetry()

◆ setCustomBathymetry() [1/2]

◆ setCustomBathymetry() [2/2]

◆ setCustomSediment() [1/2]

◆ setCustomSediment() [2/2]

◆ setCustomSSP() [1/2]

◆ setCustomSSP() [2/2]

◆ setDebug()

◆ setResPressureDb()

◆ setResTimeArrDb()

◆ setSedimentDb()

◆ setSSPDb()

◆ updateDebugFlag()

Member Data Documentation

◆ bathymetry_db

◆ ccaltimetry_map

◆ ccbathy_map

◆ ccsediment_map

◆ ccssp_map

◆ debug

◆ results_arrivals_db

◆ results_pressure_db

◆ sediment_db

◆ ssp_db