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

All Implemented Interfaces:

android.os.Parcelable, MapperInterface
```
public class NavigationProgress
extends java.lang.Object
implements android.os.Parcelable, MapperInterface
```
Provide information of the progress of a user while following a route.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NavigationProgress.Builder
NavigationProgress builder static inner class.
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields
Modifier and Type Field Description

static android.os.Parcelable.Creator<NavigationProgress> CREATOR
- Fields inherited from interface es.situm.sdk.model.MapperInterface
  ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object o)`
`static NavigationProgress`	`fromMap(java.util.Map<java.lang.String,java.lang.Object> map)`
`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.
`java.util.List<Point>`	`getPoints()`	Returns remaining list of ordered points of the route.
`RouteStep`	`getRouteStep()`	Returns the route step/edge/fragment closest to the user, where the `getClosestLocationInRoute()` is.
`java.util.List<RouteSegment>`	`getSegments()`	Return list of ordered points split by floor, each list contains points from one floor, but can have multiple lists of the same floor.
`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.util.Map<java.lang.String,java.lang.Object>`	`toMap()`	Method to transform object into Map
`java.lang.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
```
@NonNull
public RouteStep getRouteStep()
```
    Returns the route step/edge/fragment closest to the user, where the getClosestLocationInRoute() is.
    
    Returns:
    
    RouteStep. Default is RouteStep.EMPTY.
  - getClosestPointInRoute
```
@NonNull
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
```
@FloatRange(from=0.0)
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
```
@FloatRange(from=0.0)
public double getDistanceToGoal()
```
    Returns the distance from getClosestLocationInRoute() to route's goal point.
    
    Returns:
    
    double. Default is 0.
  - getCurrentIndication
```
@NonNull
public Indication getCurrentIndication()
```
    Returns the current indication
  - getNextIndication
```
@NonNull
public Indication getNextIndication()
```
    Returns the next indication. If this is the last indication it will return Indication.EMPTY
  - getDistanceToEndStep
```
@FloatRange(from=0.0)
public double getDistanceToEndStep()
```
    Returns the distance to the end this step
  - getTimeToGoal
```
@FloatRange(from=0.0)
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
```
@FloatRange(from=0.0)
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.
  - getPoints
```
@NonNull
public java.util.List<Point> getPoints()
```
    Returns remaining list of ordered points of the route. If you want the points to display them in a map use getSegments()
    
    Returns:
    
    non-empty list of points
  - getSegments
```
@NonNull
public java.util.List<RouteSegment> getSegments()
```
    Return list of ordered points split by floor, each list contains points from one floor, but can have multiple lists of the same floor. Use this method to display segments in a map, each list should be a polyline.
    For example, if there is no path to go to the other side of the same floor and you need to go up one floor and then go down again to the original floor, this method will return one segment on the current floor, one segment on the upper floor and one more segment in the current floor.
    Drawing example: if you want to draw all the points of a floor, you should draw a polyline for each list that contains the floor you want to show.
  - 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
  - toMap
```
public java.util.Map<java.lang.String,java.lang.Object> toMap()
```
    Description copied from interface: MapperInterface
    
    Method to transform object into Map
    
    Specified by:
    
    toMap in interface MapperInterface
    
    Returns:
    
    Map with the information of the object mapped
  - fromMap
```
public static NavigationProgress fromMap(java.util.Map<java.lang.String,java.lang.Object> map)
                                  throws java.lang.IllegalArgumentException
```
    Throws:
    
    java.lang.IllegalArgumentException
  - 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

Class NavigationProgress

Nested Class Summary

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

Field Summary

Fields inherited from interface es.situm.sdk.model.MapperInterface

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

getRouteStep

getClosestPointInRoute

getClosestLocationInRoute

getDistanceToClosestPointInRoute

getDistanceToGoal

getCurrentIndication

getNextIndication

getDistanceToEndStep

getTimeToGoal

getTimeToEndStep

getPoints

getSegments

equals

hashCode

toString

toMap

fromMap

describeContents

writeToParcel