Coordinates (lat, long) class definitions and functions library. More...

#include <coordinates-definitions.h>

Inheritance diagram for woss::Coord:

Collaboration diagram for woss::Coord:

Public Member Functions
	Coord (double lat=COORD_NOT_SET_VALUE, double lon=COORD_NOT_SET_VALUE)

	Coord (const Coord &copy)

void	setLatitude (double lat)

void	setLongitude (double lon)

virtual bool	isValid () const

double	getLatitude () const

double	getLongitude () const

int	getMarsdenSquare () const

int	getMarsdenOneDegreeSquare () const

MarsdenCoord	getMarsdenCoord () const

double	getInitialBearing (const Coord &destination) const

double	getFinalBearing (const Coord &destination) const

double	getGreatCircleDistance (const Coord &destination, double depth=0) const

Coord &	operator= (const Coord &copy)

friend::std::ostream &	operator<< (::std::ostream &os, const Coord &instance)

Static Public Member Functions
static const Coord	getCoordFromBearing (const Coord &start_coord, double bearing, double distance, double depth=0.0)

static const Coord	getCoordAlongGreatCircle (const Coord &start_coord, const Coord &end_coord, double distance, double depth=0.0)

static const Coord	getCoordFromUtmWgs84 (double easting, double northing, double utm_zone_number, UtmZoneChar utm_zone_char)

Static Public Attributes
static const double	COORD_MIN_LATITUDE = -90.0
	Minimum valid Latitude.

static const double	COORD_MAX_LATITUDE = 90.0
	Maximum valid Latitude.

static const double	COORD_MIN_LONGITUDE = -180.0
	Minimum valid Longitude.

static const double	COORD_MAX_LONGITUDE = 180.0
	Maximum valid Longitude.

static const double	EARTH_RADIUS = 6371000.0
	Mean earth radius in meters.

static const double	EARTH_SEMIMAJOR_AXIS = 6378137.0
	Earth's semi-major axis in meters as defined by both GRS80 and WGS84.

static const double	EARTH_GRS80_POLAR_RADIUS = 6356752.3141
	Earth's semi-major axis in meters as defined by GRS80.

static const double	EARTH_WGS84_POLAR_RADIUS = 6356752.314245
	Earth's polar radius in meters as defined by WGS84.

static const double	EARTH_GRS80_ECCENTRICITY = 0.0818191910428158
	Earth's first eccentricity as defined by GRS80.

static const double	EARTH_WGS84_ECCENTRICITY = 0.0818191908426215
	Earth's first eccentricity as defined by WGS84.

Protected Member Functions
void	updateMarsdenCoord ()

Static Protected Member Functions
static bool	isValidUtmZoneChar (UtmZoneChar utm_zone_char)

Protected Attributes
double	latitude

double	longitude

int	marsden_square

int	marsden_one_degree

Friends
const Coord	operator+ (const Coord &left, const Coord &right)

const Coord	operator- (const Coord &left, const Coord &right)

Coord &	operator+= (Coord &left, const Coord &right)

Coord &	operator-= (Coord &left, const Coord &right)

bool	operator== (const Coord &left, const Coord &right)

bool	operator!= (const Coord &left, const Coord &right)

bool	operator> (const Coord &left, const Coord &right)

bool	operator< (const Coord &left, const Coord &right)

bool	operator>= (const Coord &left, const Coord &right)

bool	operator<= (const Coord &left, const Coord &right)

Detailed Description

Coordinates (lat, long) class definitions and functions library.

Coord class stores a double decimal degree latitude and double decimal degree longitude. It has a reach library for Marsden coordinates, distance, bearing and arithmetic calculations. This class has virtual methods for the sole purpose of CoordZ inheritance.

Constructor & Destructor Documentation

◆ Coord() [1/2]

Coord::Coord	(	double	lat = `COORD_NOT_SET_VALUE`,
		double	lon = `COORD_NOT_SET_VALUE`
	)

Coord constructor.

Parameters

lat	decimal degree latitude value. Default value makes the instance not valid
lon	decimal degree longitude value. Default value makes the instance not valid

References updateMarsdenCoord().

Referenced by getCoordFromBearing(), and getCoordFromUtmWgs84().

Here is the call graph for this function:

◆ Coord() [2/2]

Coord::Coord ( const Coord & copy )

Coord copy constructor.

Parameters

copy	Coord to be copied

References latitude, longitude, and updateMarsdenCoord().

Here is the call graph for this function:

Member Function Documentation

◆ getCoordAlongGreatCircle()

const Coord Coord::getCoordAlongGreatCircle	(	const Coord &	start_coord,
		const Coord &	end_coord,
		double	distance,
		double	depth = `0.0`
	)

static

Gets destination Cood given bearing and distance from a start Coord, travelling along a (shortest distance) great circle arc of given depth to end Coord

Parameters

start_coord	valid start Coord instance
end_coord	valid end Coord instance
distance	distance measured in meters
depth	depth measured in meters

Returns: a new Coord instance containing the destination coordinates

References getCoordFromBearing(), and getInitialBearing().

Referenced by woss::CoordZ::getCoordZAlongGreatCircle().

Here is the call graph for this function:

◆ getCoordFromBearing()

const Coord Coord::getCoordFromBearing	(	const Coord &	start_coord,
		double	bearing,
		double	distance,
		double	depth = `0.0`
	)

static

Gets destination Cood given bearing and distance from a start Coord, travelling along a (shortest distance) great circle arc of given depth

Parameters

start_coord	valid start Coord instance
bearing	bearing measured in radians
distance	distance measured in meters
depth	depth measured in meters

Returns: a new Coord instance containing the destination coordinates

References Coord(), EARTH_RADIUS, isValid(), latitude, and longitude.

Referenced by getCoordAlongGreatCircle(), and woss::ACToolboxWoss::initCoordZVector().

Here is the call graph for this function:

◆ getCoordFromUtmWgs84()

const Coord Coord::getCoordFromUtmWgs84	(	double	easting,
		double	northing,
		double	utm_zone_number,
		UtmZoneChar	utm_zone_char
	)

static

Gets destination Cood given easting and northing in UTM - WGS84 coordinates

Parameters

easting	valid easting relative to central UTM zone meridian
end_coord	valid northing
utm_zone_number	validzone number
utm_zone_char	validzone character

Returns: a new Coord instance containing the destination coordinates

References Coord(), EARTH_SEMIMAJOR_AXIS, EARTH_WGS84_POLAR_RADIUS, isValidUtmZoneChar(), latitude, and longitude.

Here is the call graph for this function:

◆ getFinalBearing()

double Coord::getFinalBearing ( const Coord & destination ) const

Gets the final bearing of a trajectory

Parameters

destination destination Coord instance

Returns: initial bearing measured in radians

References getInitialBearing().

Here is the call graph for this function:

◆ getGreatCircleDistance()

double Coord::getGreatCircleDistance	(	const Coord &	destination,
		double	depth = `0`
	)		const

Gets calculates great-circle distances between the two points – that is, the shortest distance over the earth’s surface – using the ‘Haversine’ formula

Parameters

destination valid destination Coord instance

Returns: distance measured in meters

References EARTH_RADIUS, isValid(), latitude, and longitude.

Referenced by woss::CoordZ::getCoordZAlongGreatCircle(), woss::WossManager::getWossPressure(), woss::WossManagerResDb::getWossTimeArr(), woss::WossManagerResDbMT::getWossTimeArr(), woss::WossManager::getWossTimeArr(), woss::ACToolboxWoss::initAltimetry(), woss::Woss::initialize(), and woss::WossDbManager::RangeOperator::operator()().

Here is the call graph for this function:

◆ getInitialBearing()

double Coord::getInitialBearing ( const Coord & destination ) const

Gets the initial bearing of a trajectory

Parameters

destination destination Coord instance

Returns: initial bearing measured in radians

References isValid(), latitude, and longitude.

Referenced by getCoordAlongGreatCircle(), getFinalBearing(), woss::Woss::initialize(), and woss::WossDbManager::BearingOperator::operator()().

Here is the call graph for this function:

◆ getLatitude()

double woss::Coord::getLatitude ( ) const

inline

Gets the latitude value

Returns: latitude value of the instance

References latitude.

Referenced by woss::BellhopWoss::checkDepthOffsets(), woss::BellhopWoss::checkRangeOffsets(), woss::BathyGebcoDb::get1DBathyIndex(), woss::BathyGebcoDb::get2DBathyIndexes(), woss::SSP::getDepthfromPressure(), woss::Location::getLatitude(), woss::SSP::getPressureFromDepth(), woss::SedimDeck41CoordDb::getSeaFloorType(), woss::SedimDeck41CoordDb::getSedimIndex(), woss::SedimDeck41CoordDb::getSedimIndexes(), woss::SspWoa2005Db::getSSPIndexes(), woss::UtmWgs84::getUtmWgs84FromCoord(), woss::BathyGebcoDb::getValue(), woss::SSP::isAntarcticOcean(), woss::SSP::isArcticOcean(), woss::SSP::isBalticSea(), woss::SSP::isBlackSea(), woss::SSP::isCanonOcean(), woss::SSP::isCelebesSea(), woss::SSP::isHalmaheraSea(), woss::SSP::isJapanSea(), woss::SSP::isMediterraneanSea(), woss::SSP::isNEAtlanticOcean(), woss::SSP::isRedSea(), woss::SSP::isSuluSea(), and woss::Location::operator<<().

◆ getLongitude()

double woss::Coord::getLongitude ( ) const

inline

Gets the longitude value

Returns: longitude value of the instance

References longitude.

Referenced by woss::BellhopWoss::checkDepthOffsets(), woss::BellhopWoss::checkRangeOffsets(), woss::Location::getLongitude(), woss::SedimDeck41CoordDb::getSedimIndexes(), woss::SspWoa2005Db::getSSPIndexes(), woss::UtmWgs84::getUtmWgs84FromCoord(), woss::SSP::isBalticSea(), woss::SSP::isBlackSea(), woss::SSP::isCelebesSea(), woss::SSP::isHalmaheraSea(), woss::SSP::isJapanSea(), woss::SSP::isMediterraneanSea(), woss::SSP::isNEAtlanticOcean(), woss::SSP::isRedSea(), woss::SSP::isSuluSea(), and woss::Location::operator<<().

◆ getMarsdenCoord()

MarsdenCoord woss::Coord::getMarsdenCoord ( ) const

inline

Gets the marsden coordinates

Returns: complete marsden coordinates of the instance

References marsden_one_degree, and marsden_square.

◆ getMarsdenOneDegreeSquare()

int woss::Coord::getMarsdenOneDegreeSquare ( ) const

inline

Gets the marsden one degree square value

Returns: marsden one degree square value of the instance

References marsden_one_degree.

◆ getMarsdenSquare()

int woss::Coord::getMarsdenSquare ( ) const

inline

Gets the marsden square value

Returns: marsden square value of the instance

References marsden_square.

◆ isValid()

virtual bool woss::Coord::isValid ( ) const

inlinevirtual

Checks the validity of coordinates provided

Returns: true if coordinates are valid, false otherwise

Reimplemented in woss::CoordZ.

References COORD_MAX_LATITUDE, COORD_MAX_LONGITUDE, COORD_MIN_LATITUDE, COORD_MIN_LONGITUDE, latitude, and longitude.

Referenced by getCoordFromBearing(), getGreatCircleDistance(), getInitialBearing(), woss::SSP::insertValue(), woss::CoordZ::isValid(), woss::operator+=(), woss::operator-=(), woss::SSP::transform(), and updateMarsdenCoord().

◆ isValidUtmZoneChar()

bool Coord::isValidUtmZoneChar ( UtmZoneChar utm_zone_char )

staticprotected

Checks if the passed utm zone character is valid

Parameters

utm_zone_char utm zone character

Returns: true if valid, false otherwise

Referenced by getCoordFromUtmWgs84().

◆ operator<<()

friend::std::ostream & woss::Coord::operator<<	(	::std::ostream &	os,
		const Coord &	instance
	)

<< operator

Parameters

os	left operand ostream reference
instance	right operand const Coord reference

Returns: os reference after the operation

◆ operator=()

Coord & Coord::operator= ( const Coord & copy )

Assignment operator

Parameters

copy	const reference to a Coord object to be copied

Returns: Coord reference to this

References latitude, longitude, marsden_one_degree, and marsden_square.

◆ setLatitude()

void woss::Coord::setLatitude ( double lat )

inline

Sets latitude and updates marsden coordinates

Parameters

lat	latitude value

References latitude, and updateMarsdenCoord().

Referenced by woss::Location::setLatitude().

Here is the call graph for this function:

◆ setLongitude()

void woss::Coord::setLongitude ( double lon )

inline

Sets longitude and updates marsden coordinates

Parameters

lon	longitude value

References longitude, and updateMarsdenCoord().

Referenced by woss::Location::setLongitude().

Here is the call graph for this function:

◆ updateMarsdenCoord()

void Coord::updateMarsdenCoord ( )

protected

Calculates marsden coordinates from latitude and longitude

References isValid(), latitude, longitude, marsden_one_degree, and marsden_square.

Referenced by Coord(), setLatitude(), and setLongitude().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const Coord &	left,
		const Coord &	right
	)

friend

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left != right, false otherwise

◆ operator+

const Coord operator+	(	const Coord &	left,
		const Coord &	right
	)

friend

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+=

Coord & operator+=	(	Coord &	left,
		const Coord &	right
	)

friend

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator-

const Coord operator-	(	const Coord &	left,
		const Coord &	right
	)

friend

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-=

Coord & operator-=	(	Coord &	left,
		const Coord &	right
	)

friend

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

◆ operator<

bool operator<	(	const Coord &	left,
		const Coord &	right
	)

friend

Less than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left < right, false otherwise

◆ operator<=

bool operator<=	(	const Coord &	left,
		const Coord &	right
	)

friend

Less than or equal to operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left <= right, false otherwise

◆ operator==

bool operator==	(	const Coord &	left,
		const Coord &	right
	)

friend

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

◆ operator>

bool operator>	(	const Coord &	left,
		const Coord &	right
	)

friend

Greater than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left > right, false otherwise

◆ operator>=

bool operator>=	(	const Coord &	left,
		const Coord &	right
	)

friend

Greater than or equal to operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left >= right, false otherwise

Member Data Documentation

◆ latitude

double woss::Coord::latitude

protected

Latitude value

Referenced by Coord(), woss::CoordZ::getCartCoords(), getCoordFromBearing(), getCoordFromUtmWgs84(), woss::CoordZ::getCoordZFromCartesianCoords(), getGreatCircleDistance(), getInitialBearing(), getLatitude(), woss::CoordZ::getSphericalTheta(), isValid(), woss::operator+=(), woss::operator-=(), operator=(), woss::CoordZ::operator=(), setLatitude(), and updateMarsdenCoord().

◆ longitude

double woss::Coord::longitude

protected

Longitude value

Referenced by Coord(), woss::CoordZ::getCartCoords(), getCoordFromBearing(), getCoordFromUtmWgs84(), woss::CoordZ::getCoordZFromCartesianCoords(), getGreatCircleDistance(), getInitialBearing(), getLongitude(), woss::CoordZ::getSphericalPhi(), isValid(), woss::operator+=(), woss::operator-=(), operator=(), woss::CoordZ::operator=(), setLongitude(), and updateMarsdenCoord().

◆ marsden_one_degree

int woss::Coord::marsden_one_degree

protected

Marsden one degree square value

Referenced by getMarsdenCoord(), getMarsdenOneDegreeSquare(), operator=(), woss::CoordZ::operator=(), and updateMarsdenCoord().

◆ marsden_square

int woss::Coord::marsden_square

protected

Marsden square value

Referenced by getMarsdenCoord(), getMarsdenSquare(), operator=(), woss::CoordZ::operator=(), and updateMarsdenCoord().

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

woss/woss_def/coordinates-definitions.h
woss/woss_def/coordinates-definitions.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Coord() [1/2]

◆ Coord() [2/2]

Member Function Documentation

◆ getCoordAlongGreatCircle()

◆ getCoordFromBearing()

◆ getCoordFromUtmWgs84()

◆ getFinalBearing()

◆ getGreatCircleDistance()

◆ getInitialBearing()

◆ getLatitude()

◆ getLongitude()

◆ getMarsdenCoord()

◆ getMarsdenOneDegreeSquare()

◆ getMarsdenSquare()

◆ isValid()

◆ isValidUtmZoneChar()

◆ operator<<()

◆ operator=()

◆ setLatitude()

◆ setLongitude()

◆ updateMarsdenCoord()

Friends And Related Function Documentation

◆ operator!=

◆ operator+

◆ operator+=

◆ operator-

◆ operator-=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

Member Data Documentation

◆ latitude

◆ longitude

◆ marsden_one_degree

◆ marsden_square