WossPosition Class Reference

Inheritance diagram for WossPosition:

Collaboration diagram for WossPosition:

Public Member Functions
	WossPosition (double latitude, double longitude, double depth=0, double dist=LOCATION_COMPARISON_DISTANCE)
	WossPosition (const woss::CoordZ &coordz=woss::CoordZ(), double dist=LOCATION_COMPARISON_DISTANCE)
virtual WossPosition *	create (double latitude, double longitude, double depth=0, double dist=LOCATION_COMPARISON_DISTANCE) const
virtual WossPosition *	create (const woss::CoordZ &coordz=woss::CoordZ(), double dist=LOCATION_COMPARISON_DISTANCE) const
virtual WossPosition *	clone () const
virtual int	command (int argc, const char *const *argv)
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)
virtual	~Location ()
virtual Location *	create (double latitude, double longitude, double depth=0, double dist=LOCATION_COMPARISON_DISTANCE) const
virtual Location *	create (const CoordZ &coordz=CoordZ(), double dist=LOCATION_COMPARISON_DISTANCE) const
virtual Location *	clone () const
virtual bool	isValid () const
virtual bool	isEquivalentTo (const woss::CoordZ &coordz)
virtual void	setLocation (const CoordZ &coordz)
virtual void	setLatitude (double lat)
virtual void	setLongitude (double lon)
virtual void	setDepth (double depth)
virtual void	setVerticalOrientation (double angle)
virtual void	setHorizontalOrientation (double angle)
virtual CoordZ	getLocation ()
virtual double	getLatitude ()
virtual double	getLongitude ()
virtual double	getDepth ()
virtual double	getX ()
virtual double	getY ()
virtual double	getZ ()
virtual double	getVerticalOrientation ()
virtual double	getHorizontalOrientation ()
virtual double	getBearing ()
friend::std::ostream &	operator<< (::std::ostream &os, const Location &instance)

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

Member Function Documentation

clone()

virtual WossPosition * WossPosition::clone ( ) const

inlinevirtual

Location virtual factory method

Returns

a heap-allocated copy of this instance

Reimplemented from woss::Location.

create() [1/2]

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

inlinevirtual

Location virtual factory method

Parameters

coordz	coordinates
dist	distance comparison precision [m]

Returns

a heap-allocated Location object

Reimplemented from woss::Location.

create() [2/2]

virtual WossPosition * WossPosition::create ( double  latitude, double  longitude, double  depth = 0, double  dist = 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 heap-allocated Location object

Reimplemented from woss::Location.

getDepth()

double WossPosition::getDepth ( )

virtual

Gets current depth

Returns

valid depth [m]

Reimplemented from woss::Location.

References woss::Location::getDepth().

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 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 WossMPropagation::computeGain(), and WossMPropagation::getGain().

Here is the call graph for this function:

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:

setDepth()

void WossPosition::setDepth ( double  depth )

virtual

Sets initial depth

Parameters

lat	valid depth [m]

Reimplemented from woss::Location.

References woss::Location::setDepth().

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:

---

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

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