NavigationProgress (Situm Android SDK 2.33.0)

java.lang.Object
- es.situm.sdk.model.navigation.NavigationProgress

```
public class NavigationProgress
extends java.lang.Object
```
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
Modifier and Type	Class and Description
`static class`	`NavigationProgress.Builder` `NavigationProgress` builder static inner class.

Field Summary

Fields
Modifier and Type Field and Description

static <any> CREATOR

Fields
Modifier and Type	Field and Description
`static <any>`	`CREATOR`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object o)`
`Location`	`getClosestLocationInRoute()` Returns the closest location in the route from the user location provided to `NavigationManager.updateWithLocation(Location)`.
`Point`	`getClosestPointInRoute()` Deprecated. Use `getClosestLocationInRoute()`
`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 location (`getClosestLocationInRoute()`).
`double`	`getDistanceToEndStep()` Returns the distance to the end this step
`double`	`getDistanceToGoal()` Returns the distance from `getClosestLocationInRoute()` 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 `getClosestLocationInRoute()` is.
`double`	`getTimeToEndStep()` Returns the estimated time to go from `getClosestLocationInRoute()` to the end of `getRouteStep()`, considering a speed of 1 meter/second
`double`	`getTimeToGoal()` Returns the estimated time to go from `getClosestLocationInRoute()` to the goal/end of route, considering a speed of 1 meter/second
`int`	`hashCode()`
`java.lang.String`	`toString()`
`void`	`writeToParcel(Parcel dest, int flags)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final <any> CREATOR
```
- Method Detail
  - getRouteStep
```
public RouteStep getRouteStep()
```
    Returns the route step/edge/fragment closest to the user, where the getClosestLocationInRoute() is.
    
    Returns:
    
    RouteStep. Default is RouteStep.EMPTY.
  - getClosestPointInRoute
```
public Point getClosestPointInRoute()
```
    Deprecated. Use getClosestLocationInRoute()
    
    Returns the route point closest to the user location provided to NavigationManager.updateWithLocation(Location). For route navigation, we assume this as the user location.
  - getClosestLocationInRoute
```
public Location getClosestLocationInRoute()
```
    Returns the closest location in the route from the user location provided to NavigationManager.updateWithLocation(Location). For route navigation, we assume this as the user location.
    
    Returns:
    
    Location
  - getDistanceToClosestPointInRoute
```
public double getDistanceToClosestPointInRoute()
```
    Returns the distance between the real user location (provided to NavigationManager.updateWithLocation(Location)) and the closest route location (getClosestLocationInRoute()).
    
    Returns:
    
    double. Default is 0.
  - getDistanceToGoal
```
public double getDistanceToGoal()
```
    Returns the distance from getClosestLocationInRoute() 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 getClosestLocationInRoute() 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 getClosestLocationInRoute() to the end of getRouteStep(), considering a speed of 1 meter/second
    
    Returns:
    
    double. Default is 0.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - describeContents
```
public int describeContents()
```
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```

Class NavigationProgress

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

getRouteStep

getClosestPointInRoute

getClosestLocationInRoute

getDistanceToClosestPointInRoute

getDistanceToGoal

getCurrentIndication

getNextIndication

getDistanceToEndStep

getTimeToGoal

getTimeToEndStep

equals

hashCode

toString

describeContents

writeToParcel