Provides the interface for the woss::Coord and woss::CoordZ classes. More...

Classes
class	woss::Coord
	Coordinates (lat, long) class definitions and functions library. More...

class	woss::CoordZ
	3D-Coordinates (lat, long, depth) class definitions and functions library More...

class	woss::CoordZ::CartCoords
	Class that represents cartesian coordinates. More...

class	woss::UtmWgs84

class	woss::CoordComparator< CompUser, T >
	Function object for partial ordering of coordinates. More...

class	woss::CoordComparator< CompUser, CoordZ >
	Partial specialization for partial ordering of CoordZ coordinates. More...

Typedefs
typedef char	woss::UtmZoneChar

typedef ::std::vector< CoordZ >	woss::CoordZVector

typedef int	woss::Marsden

typedef ::std::pair< int, int >	woss::MarsdenCoord

typedef ::std::vector< Coord >	woss::CoordVector

typedef ::std::vector< Marsden >	woss::MarsdenVector

typedef ::std::vector< MarsdenCoord >	woss::MarsdenCoordVector

Functions
Coord &	woss::operator+= (Coord &left, const Coord &right)

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

CoordZ &	woss::operator+= (CoordZ &left, const CoordZ &right)

CoordZ &	woss::operator-= (CoordZ &left, const CoordZ &right)

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

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

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

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

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

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

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

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

inline ::std::ostream &	woss::operator<< (::std::ostream &os, const Coord &x)

inline ::std::ostream &	woss::operator<< (::std::ostream &os, const CoordZ::CartCoords &instance)

bool	woss::operator== (const CoordZ &left, const CoordZ &right)

bool	woss::operator!= (const CoordZ &left, const CoordZ &right)

bool	woss::operator> (const CoordZ &left, const CoordZ &right)

bool	woss::operator< (const CoordZ &left, const CoordZ &right)

bool	woss::operator>= (const CoordZ &left, const CoordZ &right)

bool	woss::operator<= (const CoordZ &left, const CoordZ &right)

inline ::std::ostream &	woss::operator<< (::std::ostream &os, const CoordZ &instance)

const CoordZ	woss::operator+ (const CoordZ &left, const CoordZ &right)

const CoordZ	woss::operator- (const CoordZ &left, const CoordZ &right)

inline ::std::ostream &	woss::operator<< (::std::ostream &os, const UtmWgs84 &instance)

Detailed Description

Provides the interface for the woss::Coord and woss::CoordZ classes.

Author: Federico Guerra

Provides the interface for the woss::Coord and woss::CoordZ classes

Typedef Documentation

◆ CoordVector

typedef ::std::vector< Coord > woss::CoordVector

A vector of Coord

◆ CoordZVector

typedef ::std::vector< CoordZ > woss::CoordZVector

A vector of CoordZ. Beware of object slicing if using this container for objects derived from CoordZ

◆ Marsden

typedef int woss::Marsden

The marsden square

◆ MarsdenCoord

typedef ::std::pair< int, int > woss::MarsdenCoord

The Marsden coordinates

Parameters

int	marsden square
int	marsden one degree square

◆ MarsdenCoordVector

typedef ::std::vector< MarsdenCoord > woss::MarsdenCoordVector

A vector of marsden coordinates

◆ MarsdenVector

typedef ::std::vector< Marsden > woss::MarsdenVector

A vector of marsden squares

◆ UtmZoneChar

typedef char woss::UtmZoneChar

The letter that identify a UTM zone

Function Documentation

◆ operator!=() [1/2]

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

inline

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left != right, false otherwise

◆ operator!=() [2/2]

bool woss::operator!=	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left != right, false otherwise

◆ operator+() [1/2]

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

inline

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+() [2/2]

const CoordZ woss::operator+	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+=() [1/2]

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

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::Coord::isValid(), woss::Coord::latitude, woss::Coord::longitude, and woss::operator+=().

Here is the call graph for this function:

◆ operator+=() [2/2]

CoordZ & woss::operator+=	(	CoordZ &	left,
		const CoordZ &	right
	)

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::CoordZ::depth, woss::CoordZ::isValid(), woss::Coord::latitude, woss::Coord::longitude, and woss::operator+=().

Here is the call graph for this function:

◆ operator-() [1/2]

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

inline

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-() [2/2]

const CoordZ woss::operator-	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-=() [1/2]

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

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::Coord::isValid(), woss::Coord::latitude, woss::Coord::longitude, and woss::operator-=().

Here is the call graph for this function:

◆ operator-=() [2/2]

CoordZ & woss::operator-=	(	CoordZ &	left,
		const CoordZ &	right
	)

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::CoordZ::depth, woss::CoordZ::isValid(), woss::Coord::latitude, woss::Coord::longitude, and woss::operator-=().

Here is the call graph for this function:

◆ operator<() [1/2]

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

inline

Less than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left < right, false otherwise

Referenced by woss::CoordComparator< CompUser, CoordZ >::operator()(), and woss::CoordComparator< CompUser, T >::operator()().

◆ operator<() [2/2]

bool woss::operator<	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Less than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left < right, false otherwise

◆ operator<=() [1/2]

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

inline

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<=() [2/2]

bool woss::operator<=	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

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==() [1/2]

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

inline

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

◆ operator==() [2/2]

bool woss::operator==	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

◆ operator>() [1/2]

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

inline

Greater than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left > right, false otherwise

◆ operator>() [2/2]

bool woss::operator>	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Greater than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left > right, false otherwise

◆ operator>=() [1/2]

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

inline

Greater than or equal to operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left >= right, false otherwise

◆ operator>=() [2/2]

bool woss::operator>=	(	const CoordZ &	left,
		const CoordZ &	right
	)

inline

Greater than or equal to operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left >= right, false otherwise

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ CoordVector

◆ CoordZVector

◆ Marsden

◆ MarsdenCoord

◆ MarsdenCoordVector

◆ MarsdenVector

◆ UtmZoneChar

Function Documentation

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator<=() [1/2]

◆ operator<=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ operator>=() [1/2]

◆ operator>=() [2/2]