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 ()

virtual WossDb *const	createWossDb ()

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 ()

Public Member Functions inherited from woss::WossDbCreator
	WossDbCreator ()

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 *const woss_db)

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

bool	woss_db_debug

::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()

BathyUtmCsvDbCreator::BathyUtmCsvDbCreator ( )

Default BathyUtmCsvDbCreator constructor

Member Function Documentation

◆ createWossDb()

WossDb *const BathyUtmCsvDbCreator::createWossDb ( )

virtual

Creates and initialize a BathyUtmCsvDb object

Returns: a pointer 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, woss::BathyUtmCsvDb::setCSVSeparator(), woss::BathyUtmCsvDb::setDbRangeEasting(), woss::BathyUtmCsvDb::setDbRangeNorthing(), woss::BathyUtmCsvDb::setDbSpacing(), woss::BathyUtmCsvDb::setDbTotalValues(), woss::BathyUtmCsvDb::setLandApproximationFlag(), 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 ( )

inline

Returns the current land approximation flag

Returns: the land approximation flag

References approx_land_to_sea_surface.

◆ initializeDb()

bool BathyUtmCsvDbCreator::initializeDb ( WossDb *const woss_db )

protectedvirtual

Initializes the pointed object

Parameters

woss_db pointer 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:

◆ 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 separator.

◆ 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 range_easting_end, and range_easting_start.

◆ 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 range_northing_end, and range_northing_start.

◆ setDbSpacing()

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

inline

Sets db resolution, in meters

Parameters

spacing space resolution in meters

Returns: reference to *this

References db_spacing.

◆ 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 total_easting_values, and total_northing_values.

◆ 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.

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 createWossDb(), getLandApproximationFlag(), and setLandApproximationFlag().

◆ db_spacing

double woss::BathyUtmCsvDbCreator::db_spacing

protected

spatial spacing of the db, in meters

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