WossPosition Class Reference

#include <uw-woss-position.h>

Inheritance diagram for WossPosition:

Collaboration diagram for WossPosition:

Public Member Functions
	WossPosition (double latitude, double longitude, double depth=0, double dist=woss::LOCATION_COMPARISON_DISTANCE)
	WossPosition (const woss::CoordZ &coordz=woss::CoordZ(), double dist=woss::LOCATION_COMPARISON_DISTANCE)
virtual	~WossPosition () override=default
virtual std::unique_ptr< Location >	create (double latitude, double longitude, double depth=0, double dist=woss::LOCATION_COMPARISON_DISTANCE) const
virtual std::unique_ptr< Location >	create (const woss::CoordZ &coordz=woss::CoordZ(), double dist=woss::LOCATION_COMPARISON_DISTANCE) const
virtual std::unique_ptr< Location >	clone () const
virtual int	command (int argc, const char *const *argv) override
virtual void	setLatitude (double val)
virtual void	setLongitude (double val)
virtual void	setDepth (double val)
virtual void	setAltitude (double val)
virtual void	setMinVerticalOrientation (double val)
virtual void	setMaxVerticalOrientation (double val)
virtual void	setX (double val)
virtual void	setY (double val)
virtual void	setZ (double val)
virtual double	getX ()
virtual double	getY ()
virtual double	getZ ()
virtual double	getLatitude ()
virtual double	getLongitude ()
virtual double	getDepth ()
virtual double	getAltitude ()
virtual double	getMinVerticalOrientation ()
virtual double	getMaxVerticalOrientation ()
Public Member Functions inherited from woss::Location
	Location (const CoordZ &coordz=CoordZ(), double dist=LOCATION_COMPARISON_DISTANCE)
	Location (double latitude, double longitude, double depth=0, double dist=LOCATION_COMPARISON_DISTANCE)
	Location (const Location &copy)=default
	Location (Location &&tmp)=default
virtual	~Location ()=default
Location &	operator= (const Location &copy)=default
Location &	operator= (Location &&tmp)=default
virtual bool	isValid () const
virtual bool	isEquivalentTo (const woss::CoordZ &coordz)
virtual void	setLocation (const CoordZ &coordz)
virtual void	setVerticalOrientation (double angle)
virtual void	setHorizontalOrientation (double angle)
virtual CoordZ	getLocation ()
virtual double	getVerticalOrientation ()
virtual double	getHorizontalOrientation ()
virtual double	getBearing ()

Protected Attributes
double	min_vertical_orientation
double	max_vertical_orientation
Protected Attributes inherited from woss::Location
double	comparison_distance
CoordZ	curr_coordz
double	vertical_orientation
double	horizontal_orientation
double	bearing

Constructor & Destructor Documentation

WossPosition() [1/2]

WossPosition::WossPosition	(	double	latitude,
		double	longitude,
		double	depth = 0,
		double	dist = woss::LOCATION_COMPARISON_DISTANCE )

References woss::Location::comparison_distance, woss::Location::curr_coordz, woss::Location::Location(), max_vertical_orientation, min_vertical_orientation, and woss::Location::vertical_orientation.

Here is the call graph for this function:

WossPosition() [2/2]

WossPosition::WossPosition	(	const woss::CoordZ &	coordz = woss::CoordZ(),
		double	dist = woss::LOCATION_COMPARISON_DISTANCE )

References woss::Location::comparison_distance, woss::CoordZ::getCartX(), woss::CoordZ::getCartY(), woss::CoordZ::getCartZ(), woss::CoordZ::getDepth(), woss::Coord::getLatitude(), woss::Coord::getLongitude(), woss::Location::Location(), max_vertical_orientation, min_vertical_orientation, and woss::Location::vertical_orientation.

Here is the call graph for this function:

~WossPosition()

virtual WossPosition::~WossPosition ( )

overridevirtualdefault

Member Function Documentation

clone()

virtual std::unique_ptr< Location > WossPosition::clone ( ) const

inlinevirtual

Location virtual factory method

Returns

a std::unique_ptr to heap-allocated copy of this instance

Reimplemented from woss::Location.

command()

int WossPosition::command ( int argc, const char *const * argv )

overridevirtual

Reimplemented in WossWpPosition.

References getDepth(), setAltitude(), and setDepth().

Referenced by WossWpPosition::command().

Here is the call graph for this function:

create() [1/2]

virtual std::unique_ptr< Location > WossPosition::create ( const woss::CoordZ & coordz = woss::CoordZ(), double dist = woss::LOCATION_COMPARISON_DISTANCE ) const

inlinevirtual

Location virtual factory method

Parameters

coordz	coordinates
dist	distance comparison precision [m]

Returns

a std::unique_ptr to heap-allocated Location object

Reimplemented from woss::Location.

create() [2/2]

virtual std::unique_ptr< Location > WossPosition::create ( double latitude, double longitude, double depth = 0, double dist = woss::LOCATION_COMPARISON_DISTANCE ) const

inlinevirtual

Location virtual factory method

Parameters

latitude	latitude value [decimal degrees]
longitude	longitude value [decimal degrees]
depth	depth value [m]
dist	distance comparison precision [m]

Returns

a std::unique_ptr to a heap-allocated Location object

Reimplemented from woss::Location.

getAltitude()

double WossPosition::getAltitude ( )

virtual

References woss::Location::getDepth().

Referenced by WossMPropagation::computeGain(), and WossMPropagation::getGain().

Here is the call graph for this function:

getDepth()

double WossPosition::getDepth ( )

virtual

Gets current depth

Returns

valid depth [m]

Reimplemented from woss::Location.

References woss::Location::getDepth().

Referenced by command(), WossWpPosition::command(), and WossChannelModule::computeCoordZPairVect().

Here is the call graph for this function:

getLatitude()

double WossPosition::getLatitude ( )

virtual

Gets current latitude

Returns

valid latitude [decimal degrees]

Reimplemented from woss::Location.

References woss::Location::getLatitude().

Referenced by WossWpPosition::command(), WossMPropagation::computeGain(), and WossMPropagation::getGain().

Here is the call graph for this function:

getLongitude()

double WossPosition::getLongitude ( )

virtual

Gets current longitude

Returns

valid longitude [decimal degrees]

Reimplemented from woss::Location.

References woss::Location::getLongitude().

Referenced by WossWpPosition::command(), WossMPropagation::computeGain(), and WossMPropagation::getGain().

Here is the call graph for this function:

getMaxVerticalOrientation()

double WossPosition::getMaxVerticalOrientation ( )

virtual

References max_vertical_orientation.

getMinVerticalOrientation()

double WossPosition::getMinVerticalOrientation ( )

virtual

References min_vertical_orientation.

getX()

double WossPosition::getX ( )

virtual

Gets current cartesian x-axis value

Returns

x value

Reimplemented from woss::Location.

References woss::Location::getX().

Here is the call graph for this function:

getY()

double WossPosition::getY ( )

virtual

Gets current cartesian y-axis value

Returns

y value

Reimplemented from woss::Location.

References woss::Location::getY().

Here is the call graph for this function:

getZ()

double WossPosition::getZ ( )

virtual

Gets current cartesian z-axis value

Returns

z value

Reimplemented from woss::Location.

References woss::Location::getZ().

Here is the call graph for this function:

setAltitude()

void WossPosition::setAltitude ( double val )

virtual

References woss::Location::setDepth().

Referenced by command().

Here is the call graph for this function:

setDepth()

void WossPosition::setDepth ( double depth )

virtual

Sets initial depth

Parameters

lat	valid depth [m]

Reimplemented from woss::Location.

References woss::Location::setDepth().

Referenced by command().

Here is the call graph for this function:

setLatitude()

void WossPosition::setLatitude ( double lat )

virtual

Sets initial latitude

Parameters

lat	valid latitude [decimal degrees]

Reimplemented from woss::Location.

References woss::Location::setLatitude().

Here is the call graph for this function:

setLongitude()

void WossPosition::setLongitude ( double lon )

virtual

Sets initial longitude

Parameters

lat	valid longitude [decimal degrees]

Reimplemented from woss::Location.

References woss::Location::setLongitude().

Here is the call graph for this function:

setMaxVerticalOrientation()

void WossPosition::setMaxVerticalOrientation ( double val )

virtual

References max_vertical_orientation.

setMinVerticalOrientation()

void WossPosition::setMinVerticalOrientation ( double val )

virtual

References min_vertical_orientation.

setX()

void WossPosition::setX ( double val )

virtual

setY()

void WossPosition::setY ( double val )

virtual

setZ()

void WossPosition::setZ ( double val )

virtual

Member Data Documentation

max_vertical_orientation

double WossPosition::max_vertical_orientation

protected

Referenced by getMaxVerticalOrientation(), setMaxVerticalOrientation(), WossWpPosition::updateVerticalOrientation(), WossPosition(), and WossPosition().

min_vertical_orientation

double WossPosition::min_vertical_orientation

protected

Referenced by getMinVerticalOrientation(), setMinVerticalOrientation(), WossWpPosition::updateVerticalOrientation(), WossPosition(), and WossPosition().

---

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

• woss_phy/uw-woss-position.h
• woss_phy/uw-woss-position.cpp