WossDbCreator for the UMT CSV bathymetry database. More...

#include <bathymetry-utm-csv-db-creator.h>

Inheritance diagram for woss::BathyUtmCsvDbCreator:

Collaboration diagram for woss::BathyUtmCsvDbCreator:

Public Member Functions
	BathyUtmCsvDbCreator ()
	BathyUtmCsvDbCreator (const BathyUtmCsvDbCreator &copy)=default
	BathyUtmCsvDbCreator (BathyUtmCsvDbCreator &&tmp)=default
virtual	~BathyUtmCsvDbCreator () override=default
BathyUtmCsvDbCreator &	operator= (const BathyUtmCsvDbCreator &copy)=default
BathyUtmCsvDbCreator &	operator= (BathyUtmCsvDbCreator &&tmp)=default
virtual std::unique_ptr< WossDbCreator >	clone () const override
virtual std::unique_ptr< WossDb >	createWossDb () const override
BathyUtmCsvDbCreator &	setCSVSeparator (const char new_separator)
const char	getCSVSeparator () const
BathyUtmCsvDbCreator &	setDbSpacing (double spacing)
double	getDbSpacing () const
BathyUtmCsvDbCreator &	setDbTotalValues (int nnorth, int neast)
std::pair< int, int >	getDbTotalValues () const
BathyUtmCsvDbCreator &	setDbRangeEasting (double start, double end)
std::pair< double, double >	getDbRangeEasting () const
BathyUtmCsvDbCreator &	setDbRangeNorthing (double start, double end)
std::pair< double, double >	getDbRangeNorthing () const
BathyUtmCsvDbCreator &	setLandApproximationFlag (bool flag)
bool	getLandApproximationFlag () const
Public Member Functions inherited from woss::WossDbCreator
	WossDbCreator ()=default
	WossDbCreator (const WossDbCreator &copy)=default
	WossDbCreator (WossDbCreator &&tmp)=default
virtual	~WossDbCreator ()=default
WossDbCreator &	operator= (const WossDbCreator &copy)=default
WossDbCreator &	setDebug (bool flag)
WossDbCreator &	setWossDebug (bool flag)
WossDbCreator &	setDbPathName (const std::string &name)
bool	isUsingDebug () const
bool	isUsingWossDbDebug () const
std::string	getDbPathName () const

Protected Member Functions
virtual bool	initializeDb (WossDb &woss_db) const override

Protected Attributes
char	separator
double	db_spacing
int	total_northing_values
int	total_easting_values
double	range_easting_start
double	range_easting_end
double	range_northing_start
double	range_northing_end
bool	approx_land_to_sea_surface
Protected Attributes inherited from woss::WossDbCreator
bool	debug = false
bool	woss_db_debug = false
std::string	pathname = ""

Detailed Description

WossDbCreator for the UMT CSV bathymetry database.

Specialization of WossDbCreator for the UMT CSV bathymetry database.

Constructor & Destructor Documentation

◆ BathyUtmCsvDbCreator() [1/3]

BathyUtmCsvDbCreator::BathyUtmCsvDbCreator ( )

Default BathyUtmCsvDbCreator constructor

References approx_land_to_sea_surface, db_spacing, range_easting_end, range_easting_start, range_northing_end, range_northing_start, separator, total_easting_values, and total_northing_values.

Referenced by BathyUtmCsvDbCreator(), BathyUtmCsvDbCreator(), operator=(), operator=(), setCSVSeparator(), setDbRangeEasting(), setDbRangeNorthing(), setDbSpacing(), setDbTotalValues(), and setLandApproximationFlag().

◆ BathyUtmCsvDbCreator() [2/3]

woss::BathyUtmCsvDbCreator::BathyUtmCsvDbCreator ( const BathyUtmCsvDbCreator & copy )

default

References BathyUtmCsvDbCreator().

Here is the call graph for this function:

◆ BathyUtmCsvDbCreator() [3/3]

woss::BathyUtmCsvDbCreator::BathyUtmCsvDbCreator ( BathyUtmCsvDbCreator && tmp )

default

References BathyUtmCsvDbCreator().

Here is the call graph for this function:

◆ ~BathyUtmCsvDbCreator()

virtual woss::BathyUtmCsvDbCreator::~BathyUtmCsvDbCreator ( )

overridevirtualdefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr< WossDbCreator > woss::BathyUtmCsvDbCreator::clone ( ) const

inlineoverridevirtual

Abstract method. Virtual factory method. It is called to clone this WossDbCreator instance. The caller will be the owner of created object, therefore object destruction is his responsibility

Returns: a std::unique_ptr to a properly initialized WossDbCreator object

Implements woss::WossDbCreator.

◆ createWossDb()

std::unique_ptr< WossDb > BathyUtmCsvDbCreator::createWossDb ( ) const

overridevirtual

Creates and initialize a BathyUtmCsvDb object

Returns: a std::unique_ptr to a properly initialized BathyUtmCsvDb object

Implements woss::WossDbCreator.

References approx_land_to_sea_surface, db_spacing, initializeDb(), woss::WossDbCreator::pathname, range_easting_end, range_easting_start, range_northing_end, range_northing_start, separator, total_easting_values, and total_northing_values.

Here is the call graph for this function:

◆ getCSVSeparator()

const char woss::BathyUtmCsvDbCreator::getCSVSeparator ( ) const

inline

Returns the current char separator

Returns: the char separator

References separator.

◆ getDbRangeEasting()

std::pair< double, double > woss::BathyUtmCsvDbCreator::getDbRangeEasting ( ) const

inline

Returns the current db range easting

Returns: the db easting range start and end

References range_easting_end, and range_easting_start.

◆ getDbRangeNorthing()

std::pair< double, double > woss::BathyUtmCsvDbCreator::getDbRangeNorthing ( ) const

inline

Returns the current db range northing

Returns: the db easting range start and end

References range_northing_end, and range_northing_start.

◆ getDbSpacing()

double woss::BathyUtmCsvDbCreator::getDbSpacing ( ) const

inline

Returns the current db spatial resolution

Returns: the db spatial resolution in meters

References db_spacing.

◆ getDbTotalValues()

std::pair< int, int > woss::BathyUtmCsvDbCreator::getDbTotalValues ( ) const

inline

Returns the total northing and easting values

Returns: pair of total northing and easting values

References total_easting_values, and total_northing_values.

◆ getLandApproximationFlag()

bool woss::BathyUtmCsvDbCreator::getLandApproximationFlag ( ) const

inline

Returns the current land approximation flag

Returns: the land approximation flag

References approx_land_to_sea_surface.

◆ initializeDb()

bool BathyUtmCsvDbCreator::initializeDb ( WossDb & woss_db ) const

overrideprotectedvirtual

Initializes the pointed object

Parameters

woss_db reference to a recently created BathyUtmCsvDb

Returns: true if the method succeed, false otherwise

Implements woss::WossDbCreator.

References woss::WossDbCreator::initializeDb().

Referenced by createWossDb().

Here is the call graph for this function:

◆ operator=() [1/2]

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::operator= ( BathyUtmCsvDbCreator && tmp )

default

References BathyUtmCsvDbCreator().

Here is the call graph for this function:

◆ operator=() [2/2]

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::operator= ( const BathyUtmCsvDbCreator & copy )

default

References BathyUtmCsvDbCreator().

Here is the call graph for this function:

◆ setCSVSeparator()

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::setCSVSeparator ( const char new_separator )

inline

Sets the char separator used in CSV textual db

Parameters

new_separator separator char

Returns: reference to *this

References BathyUtmCsvDbCreator(), and separator.

Here is the call graph for this function:

◆ setDbRangeEasting()

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::setDbRangeEasting	(	double	start,
		double	end )

inline

Sets db range easting start and end

Parameters

start	easting range start
end	easting range end

Returns: reference to *this

References BathyUtmCsvDbCreator(), range_easting_end, and range_easting_start.

Here is the call graph for this function:

◆ setDbRangeNorthing()

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::setDbRangeNorthing	(	double	start,
		double	end )

inline

Sets db northing range start and end

Parameters

start	northing range start
end	northing range end

Returns: reference to *this

References BathyUtmCsvDbCreator(), range_northing_end, and range_northing_start.

Here is the call graph for this function:

◆ setDbSpacing()

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::setDbSpacing ( double spacing )

inline

Sets db resolution, in meters

Parameters

spacing space resolution in meters

Returns: reference to *this

References BathyUtmCsvDbCreator(), and db_spacing.

Here is the call graph for this function:

◆ setDbTotalValues()

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::setDbTotalValues	(	int	nnorth,
		int	neast )

inline

Sets the db total northing and easting values

Parameters

nnorth	db total northing points. should be >= 0
neast	db total easting points. should be >= 0

Returns: reference to *this

References BathyUtmCsvDbCreator(), total_easting_values, and total_northing_values.

Here is the call graph for this function:

◆ setLandApproximationFlag()

BathyUtmCsvDbCreator & woss::BathyUtmCsvDbCreator::setLandApproximationFlag ( bool flag )

inline

Sets land approximation flag

Parameters

flag	land approximation flag

Returns: reference to *this

References approx_land_to_sea_surface, and BathyUtmCsvDbCreator().

Here is the call graph for this function:

Member Data Documentation

◆ approx_land_to_sea_surface

bool woss::BathyUtmCsvDbCreator::approx_land_to_sea_surface

protected

Approximate land db points to sea surface

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getLandApproximationFlag(), and setLandApproximationFlag().

◆ db_spacing

double woss::BathyUtmCsvDbCreator::db_spacing

protected

spatial spacing of the db, in meters

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbSpacing(), and setDbSpacing().

◆ range_easting_end

double woss::BathyUtmCsvDbCreator::range_easting_end

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbRangeEasting(), and setDbRangeEasting().

◆ range_easting_start

double woss::BathyUtmCsvDbCreator::range_easting_start

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbRangeEasting(), and setDbRangeEasting().

◆ range_northing_end

double woss::BathyUtmCsvDbCreator::range_northing_end

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbRangeNorthing(), and setDbRangeNorthing().

◆ range_northing_start

double woss::BathyUtmCsvDbCreator::range_northing_start

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbRangeNorthing(), and setDbRangeNorthing().

◆ separator

char woss::BathyUtmCsvDbCreator::separator

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getCSVSeparator(), and setCSVSeparator().

◆ total_easting_values

int woss::BathyUtmCsvDbCreator::total_easting_values

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbTotalValues(), and setDbTotalValues().

◆ total_northing_values

int woss::BathyUtmCsvDbCreator::total_northing_values

protected

Separator used in the csv file

Referenced by BathyUtmCsvDbCreator(), createWossDb(), getDbTotalValues(), and setDbTotalValues().

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

woss/woss_db/bathymetry-utm-csv-db-creator.h
woss/woss_db/bathymetry-utm-csv-db-creator.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BathyUtmCsvDbCreator() [1/3]

◆ BathyUtmCsvDbCreator() [2/3]

◆ BathyUtmCsvDbCreator() [3/3]

◆ ~BathyUtmCsvDbCreator()

Member Function Documentation

◆ clone()

◆ createWossDb()

◆ getCSVSeparator()

◆ getDbRangeEasting()

◆ getDbRangeNorthing()

◆ getDbSpacing()

◆ getDbTotalValues()

◆ getLandApproximationFlag()

◆ initializeDb()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setCSVSeparator()

◆ setDbRangeEasting()

◆ setDbRangeNorthing()

◆ setDbSpacing()

◆ setDbTotalValues()

◆ setLandApproximationFlag()

Member Data Documentation

◆ approx_land_to_sea_surface

◆ db_spacing

◆ range_easting_end

◆ range_easting_start

◆ range_northing_end

◆ range_northing_start

◆ separator

◆ total_easting_values

◆ total_northing_values