es.situm.sdk.navigation

Class NavigationRequest.Builder

java.lang.Object

es.situm.sdk.navigation.NavigationRequest.Builder

Enclosing class:

NavigationRequest

public static final class NavigationRequest.Builder
extends java.lang.Object

NavigationState builder static inner class.

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(NavigationRequest copy)

Method Summary

Modifier and Type	Method and Description
NavigationRequest	build() Returns a NavigationState with the previously set parameters.
NavigationRequest.Builder	distanceToChangeFloorThreshold(double distanceToChangeFloorThreshold) Sets the distance threshold from when a floor change is considered reached.
NavigationRequest.Builder	distanceToChangeIndicationThreshold(double distanceToChangeIndicationThreshold) Sets the distance threshold from when the next indication is considered reached.
NavigationRequest.Builder	distanceToGoalThreshold(double distanceToGoalThreshold) Sets the distance threshold from when the goal is considered reached.
NavigationRequest.Builder	distanceToIgnoreFirstIndication(double distanceToIgnoreFirstIndication) Sets the maximum distance to ignore the first indication when navigating a route.
NavigationRequest.Builder	ignoreLowQualityLocations(boolean ignoreLowQualityLocations) Set if low quality locations should be ignored.
NavigationRequest.Builder	indicationsInterval(long millis) Sets the time to wait between indications.
NavigationRequest.Builder	outsideRouteThreshold(double outsideRouteThreshold) Sets the outsideRouteThreshold.
NavigationRequest.Builder	roundIndicationsStep(int meters) Sets the step that will be used to round indications distance.
NavigationRequest.Builder	route(Route route) Sets the Route whose progress is going to be updated.
NavigationRequest.Builder	timeToFirstIndication(long millis) Sets the time to wait until the first indication is returned.
NavigationRequest.Builder	timeToIgnoreUnexpectedFloorChanges(int millis) Sets the time (in millis) to ignore the locations received during navigation, when the next indication is a floor change, if the locations are in a wrong floor (not in origin or destination floors).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(NavigationRequest copy)

Method Detail

route

public NavigationRequest.Builder route(Route route)

Sets the Route whose progress is going to be updated.

Parameters:

route - the route to set, so that the methods can be chained together.

Returns:

a reference to this Builder

distanceToChangeFloorThreshold

public NavigationRequest.Builder distanceToChangeFloorThreshold(double distanceToChangeFloorThreshold)

Sets the distance threshold from when a floor change is considered reached. Default value is {NavigationRequest.DEFAULT_DISTANCE_CHANGE_FLOOR}.

Parameters:

distanceToChangeFloorThreshold - the distanceToChangeFloorThreshold to set, in meters.

Returns:

a reference to this Builder, so that the methods can be chained together.

distanceToChangeIndicationThreshold

public NavigationRequest.Builder distanceToChangeIndicationThreshold(double distanceToChangeIndicationThreshold)

Sets the distance threshold from when the next indication is considered reached. Default value is {NavigationRequest.DEFAULT_DISTANCE_TO_CHANGE_INDICATION}.

Parameters:

distanceToChangeIndicationThreshold - the distanceToChangeIndicationThreshold to set, in meters.

Returns:

a reference to this Builder, so that the methods can be chained together.

outsideRouteThreshold

public NavigationRequest.Builder outsideRouteThreshold(double outsideRouteThreshold)

Sets the outsideRouteThreshold. Default value is {NavigationRequest.DEFAULT_DISTANCE_THRESHOLD}.

Parameters:

outsideRouteThreshold - the outsideRouteThreshold to set

Returns:

a reference to this Builder, so that the methods can be chained together.

distanceToIgnoreFirstIndication

public NavigationRequest.Builder distanceToIgnoreFirstIndication(double distanceToIgnoreFirstIndication)

Sets the maximum distance to ignore the first indication when navigating a route. This will allow to inform the user of the next turn some metres before reaching the intersection. Default value is {NavigationRequest.DEFAULT_DISTANCE_TO_IGNORE_FIRST_INDICATION}.

Parameters:

distanceToIgnoreFirstIndication - the distanceToIgnoreFirstIndication to set

Returns:

a reference to this Builder, so that the methods can be chained together.

distanceToGoalThreshold

public NavigationRequest.Builder distanceToGoalThreshold(double distanceToGoalThreshold)

Sets the distance threshold from when the goal is considered reached. Default value is {NavigationRequest.DEFAULT_DISTANCE_THRESHOLD}.

Parameters:

distanceToGoalThreshold - the distanceToGoalThreshold to set, in meters.

Returns:

a reference to this Builder, so that the methods can be chained together.

indicationsInterval

public NavigationRequest.Builder indicationsInterval(long millis)

Sets the time to wait between indications. Default value is NavigationRequest.DEFAULT_INDICATIONS_INTERVAL milliseconds. With a value of 0 a new indication will be returned every time a new position is computed. If the value is different than 0 the indications may not be synchronized with the RouteStep in the NavigationProgress

timeToFirstIndication

public NavigationRequest.Builder timeToFirstIndication(long millis)

Sets the time to wait until the first indication is returned. This is recommended when positioning is started along with navigation, in order to provide more accurate and stable indications. Default value is NavigationRequest.DEFAULT_TIME_TO_FIRST_INDICATION milliseconds. With a value of 0 the first indication will be returned as soon as it is calculated. If a non zero value is used it will return Indication.CALCULATING during that time.

roundIndicationsStep

public NavigationRequest.Builder roundIndicationsStep(int meters)

Sets the step that will be used to round indications distance. For example, with a step of 5, a 13 meters indication will be transformed into a 15 meters indication. Default value is NavigationRequest.DEFAULT_ROUND_INDICATION_STEP meters. With a value of 0 it won't round indications distance.

timeToIgnoreUnexpectedFloorChanges

public NavigationRequest.Builder timeToIgnoreUnexpectedFloorChanges(int millis)

Sets the time (in millis) to ignore the locations received during navigation, when the next indication is a floor change, if the locations are in a wrong floor (not in origin or destination floors). Default value is NavigationRequest.DEFAULT_TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES With a value of 0 it won't ignore any location.

ignoreLowQualityLocations

public NavigationRequest.Builder ignoreLowQualityLocations(boolean ignoreLowQualityLocations)

Set if low quality locations should be ignored. With this option enabled, Location updates with Location.Quality#LOW Location.Quality will be ignored for navigation. This will improve the feasibility of the indications, specially on start and during a floor change, but navigation could freeze if too many low quality locations are received. When starting the navigation, a NavigationProgress won't be sent until a high quality location is received. You should manage this case in your application by showing a "calculating" dialog or similar. During navigation, if low quality locations are received, no NavigationProgress will be sent until a high quality location is received. Default value is NavigationRequest.DEFAULT_IGNORE_LOW_QUALITY_LOCATIONS.

build

public NavigationRequest build()
                        throws java.lang.IllegalArgumentException

Returns a NavigationState with the previously set parameters.

Returns:

NavigationState

Throws:

java.lang.IllegalArgumentException