com.oziexplorer
Class NavigationData

java.lang.Object
  com.oziexplorer.NavigationData

public class NavigationData
extends Object

Class for holding navigation data as returned by OziAPI.GPSToNavigationWaypoint().

Copyright 2011 Alan Burlison, . All rights reserved. Use is subject to license terms, see LICENSE.txt.

Field Summary

protected double	bearing Bearing to the waypoint, in degrees.
protected double	distance Remaining distance to the waypoint, in metres.
protected String	waypointDescription Dscription of the waypoint being navigated to.
protected String	waypointName Name of the waypoint being navigated to.

Method Summary

double	getBearing() Retrieve the bearing to the waypoint being navigated to.
double	getDistance() Retrieve the distance to the waypoint being navigated to.
String	getWaypointDescription() Retrieve the description of the waypoint being navigated to.
String	getWaypointName() Retrieve the name of the waypoint being navigated to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

waypointName

protected final String waypointName

Name of the waypoint being navigated to.

waypointDescription

protected final String waypointDescription

Dscription of the waypoint being navigated to.

distance

protected final double distance

Remaining distance to the waypoint, in metres.

bearing

protected final double bearing

Bearing to the waypoint, in degrees.

Method Detail

getWaypointName

public String getWaypointName()

Retrieve the name of the waypoint being navigated to.

Returns:

the waypoint name.

getWaypointDescription

public String getWaypointDescription()

Retrieve the description of the waypoint being navigated to.

Returns:

the waypoint description.

getDistance

public double getDistance()

Retrieve the distance to the waypoint being navigated to.

Returns:

the distance to the waypoint, in metres.

getBearing

public double getBearing()

Retrieve the bearing to the waypoint being navigated to.

Returns:

the bearing to the waypoint, in degrees.