Package slash.navigation.common

Class SimpleNavigationPosition

java.lang.Object

slash.navigation.common.SimpleNavigationPosition

All Implemented Interfaces:

NavigationPosition

Direct Known Subclasses:

SimpleCategorizedNavigationPosition

public class SimpleNavigationPosition
extends Object
implements NavigationPosition

A navigation position that supports just longitude, latitude, elevation, description and time.

Author:

Christian Pesch

Constructor Summary

Constructors

Constructor	Description
SimpleNavigationPosition(Double longitude, Double latitude)
SimpleNavigationPosition(Double longitude, Double latitude, Double elevation, String description)
SimpleNavigationPosition(Double longitude, Double latitude, Double elevation, String description, CompactCalendar time)
SimpleNavigationPosition(Double longitude, Double latitude, CompactCalendar time)

Method Summary

Modifier and Type	Method	Description
Double	calculateAngle(NavigationPosition other)	Calculate the angle in degree between this and the other position.
Double	calculateDistance(NavigationPosition other)	Calculate the distance in meters between this and the other position.
Double	calculateElevation(NavigationPosition other)	Calculate the elevation in meter between this and the other position.
Double	calculateOrthogonalDistance(NavigationPosition pointA, NavigationPosition pointB)	Calculate the orthogonal distance of this position to the line from pointA to pointB, supposed you are proceeding on a great circle route from A to B and end up at D, perhaps ending off course.
Double	calculateSpeed(NavigationPosition other)	Calculate the average speed in kilometers per hour between this and the other position.
Long	calculateTime(NavigationPosition other)	Calculate the time in milliseconds between this and the other position.
boolean	equals(Object o)
String	getDescription()
Double	getElevation()	Return the elevation in meters above sea level
Double	getLatitude()	Return the latitude in the WGS84 coordinate system
Double	getLongitude()	Return the longitude in the WGS84 coordinate system
Double	getSpeed()	Return the speed in kilometers per hour
CompactCalendar	getTime()	Return the date and time in UTC time zone
boolean	hasCoordinates()
int	hashCode()
boolean	hasTime()
void	setDescription(String description)
void	setElevation(Double elevation)
void	setLatitude(Double latitude)
void	setLongitude(Double longitude)
void	setSpeed(Double speed)
void	setStartDate(CompactCalendar startDate)	Set the day/month/year-offset for date-less, time-only positions
void	setTime(CompactCalendar time)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface slash.navigation.common.NavigationPosition

isStartsNewSegment

Constructor Details

SimpleNavigationPosition

public SimpleNavigationPosition(Double longitude,
 Double latitude,
 Double elevation,
 String description,
 CompactCalendar time)

SimpleNavigationPosition

public SimpleNavigationPosition(Double longitude,
 Double latitude,
 Double elevation,
 String description)

SimpleNavigationPosition

public SimpleNavigationPosition(Double longitude,
 Double latitude,
 CompactCalendar time)

SimpleNavigationPosition

public SimpleNavigationPosition(Double longitude,
 Double latitude)

Method Details

getLongitude

public Double getLongitude()

Description copied from interface: NavigationPosition

Return the longitude in the WGS84 coordinate system

Specified by:

getLongitude in interface NavigationPosition

Returns:

the longitude in the WGS84 coordinate system

setLongitude

public void setLongitude(Double longitude)

Specified by:

setLongitude in interface NavigationPosition

getLatitude

public Double getLatitude()

Description copied from interface: NavigationPosition

Return the latitude in the WGS84 coordinate system

Specified by:

getLatitude in interface NavigationPosition

Returns:

the latitude in the WGS84 coordinate system

setLatitude

public void setLatitude(Double latitude)

Specified by:

setLatitude in interface NavigationPosition

hasCoordinates

public boolean hasCoordinates()

Specified by:

hasCoordinates in interface NavigationPosition

getElevation

public Double getElevation()

Description copied from interface: NavigationPosition

Return the elevation in meters above sea level

Specified by:

getElevation in interface NavigationPosition

Returns:

the elevation in meters above sea level

setElevation

public void setElevation(Double elevation)

Specified by:

setElevation in interface NavigationPosition

getTime

public CompactCalendar getTime()

Description copied from interface: NavigationPosition

Return the date and time in UTC time zone

Specified by:

getTime in interface NavigationPosition

Returns:

the date and time in UTC time zone

setTime

public void setTime(CompactCalendar time)

Specified by:

setTime in interface NavigationPosition

hasTime

public boolean hasTime()

Specified by:

hasTime in interface NavigationPosition

getSpeed

public Double getSpeed()

Description copied from interface: NavigationPosition

Return the speed in kilometers per hour

Specified by:

getSpeed in interface NavigationPosition

Returns:

the speed in kilometers per hour

setSpeed

public void setSpeed(Double speed)

Specified by:

setSpeed in interface NavigationPosition

getDescription

public String getDescription()

Specified by:

getDescription in interface NavigationPosition

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface NavigationPosition

setStartDate

public void setStartDate(CompactCalendar startDate)

Description copied from interface: NavigationPosition

Set the day/month/year-offset for date-less, time-only positions

Specified by:

setStartDate in interface NavigationPosition

Parameters:

startDate - the day/month/year-offset

calculateDistance

public Double calculateDistance(NavigationPosition other)

Description copied from interface: NavigationPosition

Calculate the distance in meters between this and the other position.

Specified by:

calculateDistance in interface NavigationPosition

Parameters:

other - the other position

Returns:

the distance in meters between this and the other position or null if the distance cannot be calculated

calculateOrthogonalDistance

public Double calculateOrthogonalDistance(NavigationPosition pointA,
 NavigationPosition pointB)

Description copied from interface: NavigationPosition

Calculate the orthogonal distance of this position to the line from pointA to pointB, supposed you are proceeding on a great circle route from A to B and end up at D, perhaps ending off course. ... ...

Specified by:

calculateOrthogonalDistance in interface NavigationPosition

Parameters:

pointA - the first point determining the line between pointA and pointB

pointB - the second point determining the line between pointA and pointB

Returns:

the orthogonal distance to the line from pointA to pointB in meter or null if the orthogonal distance cannot be calculated

calculateAngle

public Double calculateAngle(NavigationPosition other)

Description copied from interface: NavigationPosition

Calculate the angle in degree between this and the other position.

Specified by:

calculateAngle in interface NavigationPosition

Parameters:

other - the other position

Returns:

the angle in degree between this and the other position or null if the angle cannot be calculated

calculateElevation

public Double calculateElevation(NavigationPosition other)

Description copied from interface: NavigationPosition

Calculate the elevation in meter between this and the other position.

Specified by:

calculateElevation in interface NavigationPosition

Parameters:

other - the other position

Returns:

the elevation in meter between this and the other position or null if the elevation cannot be calculated

calculateTime

public Long calculateTime(NavigationPosition other)

Description copied from interface: NavigationPosition

Calculate the time in milliseconds between this and the other position.

Specified by:

calculateTime in interface NavigationPosition

Parameters:

other - the other position

Returns:

the time in milliseconds between this and the other position or null if the time cannot be calculated

calculateSpeed

public Double calculateSpeed(NavigationPosition other)

Description copied from interface: NavigationPosition

Calculate the average speed in kilometers per hour between this and the other position.

Specified by:

calculateSpeed in interface NavigationPosition

Parameters:

other - the other position

Returns:

the speed in kilometers per hour between this and the other position or null if time or distance cannot be calculated

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object