es.situm.sdk.model.navigation

Class NavigationProgress

java.lang.Object

es.situm.sdk.model.navigation.NavigationProgress

All Implemented Interfaces:

android.os.Parcelable

public class NavigationProgress
extends Object
implements android.os.Parcelable

Provide information of the progress of a user while following a route.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavigationProgress.Builder NavigationProgress builder static inner class.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<NavigationProgress>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Point	getClosestPointInRoute() Returns the route point closest to the user location provided to NavigationManager.updateWithLocation(Location).
Indication	getCurrentIndication() Returns the current indication
double	getDistanceToClosestPointInRoute() Returns the distance between the real user location (provided to NavigationManager.updateWithLocation(Location)) and the closest route point (getClosestPointInRoute()).
double	getDistanceToEndStep() Returns the distance to the end this step
double	getDistanceToGoal() Returns the distance from getClosestPointInRoute() to route's goal point.
Indication	getNextIndication() Returns the next indication.
RouteStep	getRouteStep() Returns the route step/edge/fragment closest to the user, where the getClosestPointInRoute() is.
double	getTimeToEndStep() Returns the estimated time to go from getClosestPointInRoute() the end of getRouteStep(), considering a speed of 1 meter/second
double	getTimeToGoal() Returns the estimated time to go from getClosestPointInRoute() to the goal/end of route, considering a speed of 1 meter/second
int	hashCode()
String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<NavigationProgress> CREATOR

Method Detail

getRouteStep

public RouteStep getRouteStep()

Returns the route step/edge/fragment closest to the user, where the getClosestPointInRoute() is.

Returns:

RouteStep. Default is RouteStep.EMPTY.

getClosestPointInRoute

public Point getClosestPointInRoute()

Returns the route point closest to the user location provided to NavigationManager.updateWithLocation(Location). For route navigation, we assume this as the user location.

Returns:

RouteStep. Default is RouteStep.EMPTY.

getDistanceToClosestPointInRoute

public double getDistanceToClosestPointInRoute()

Returns the distance between the real user location (provided to NavigationManager.updateWithLocation(Location)) and the closest route point (getClosestPointInRoute()).

Returns:

double. Default is 0.

getDistanceToGoal

public double getDistanceToGoal()

Returns the distance from getClosestPointInRoute() to route's goal point.

Returns:

double. Default is 0.

getCurrentIndication

public Indication getCurrentIndication()

Returns the current indication

getNextIndication

public Indication getNextIndication()

Returns the next indication. If this is the last indication it will return Indication.EMPTY

getDistanceToEndStep

public double getDistanceToEndStep()

Returns the distance to the end this step

getTimeToGoal

public double getTimeToGoal()

Returns the estimated time to go from getClosestPointInRoute() to the goal/end of route, considering a speed of 1 meter/second

Returns:

double. Default is 0.

getTimeToEndStep

public double getTimeToEndStep()

Returns the estimated time to go from getClosestPointInRoute() the end of getRouteStep(), considering a speed of 1 meter/second

Returns:

double. Default is 0.

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

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable