public static final class GasStationManager.GasStationsOnRouteOptions extends Object
GasStationManager.GasStationsOnRouteOptions.DEFAULT_RADIUS_IN_MILES
miles.
Default distance is GasStationManager.GasStationsOnRouteOptions.DEFAULT_DISTANCE_IN_MILES
miles.Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_DISTANCE_IN_MILES
Indicates default distance to request gas stations.
|
static double |
DEFAULT_RADIUS_IN_MILES
Indicates default radius to request gas stations.
|
static double |
MAX_DISTANCE_IN_MILES
Maximum distance in miles supported, inclusive.
|
static double |
MAX_RADIUS_IN_MILES
Maximum radius in miles supported, inclusive.
|
static double |
MIN_DISTANCE_IN_MILES
Minimum distance in miles supported, exclusive.
|
static double |
MIN_RADIUS_IN_MILES
Minimum radius in miles supported, exclusive.
|
Constructor and Description |
---|
GasStationsOnRouteOptions(Route route)
Initializes a new instance of the
GasStationManager.GasStationsOnRouteOptions class using Route instance. |
Modifier and Type | Method and Description |
---|---|
void |
setBrandName(String name)
Set the requested brand name for the gas station.
|
void |
setCurrentLocation(GeoPoint currentLocation)
Set the value of current location, used to define the search region along the route.
|
void |
setDistance(double distance)
Set look ahead distance along the route.
|
void |
setRadius(double radius)
Set the radius distance to find gas stations on a route.
|
void |
setUnits(UserPreferences.Unit units)
Set the units.
|
String |
toString() |
public static final double DEFAULT_RADIUS_IN_MILES
public static final double DEFAULT_DISTANCE_IN_MILES
public static final double MIN_RADIUS_IN_MILES
public static final double MAX_RADIUS_IN_MILES
public static final double MIN_DISTANCE_IN_MILES
public static final double MAX_DISTANCE_IN_MILES
public GasStationsOnRouteOptions(@NonNull Route route)
GasStationManager.GasStationsOnRouteOptions
class using Route
instance.route
- The route.public void setCurrentLocation(GeoPoint currentLocation)
currentLocation
- An instance of GeoPoint
indicates the location.GasStationManager.GasStationsOnRouteOptions.setDistance(double).
,
GasStationManager.GasStationsOnRouteOptions.setRadius(double).
public void setBrandName(String name)
name
- The brand name.public void setRadius(double radius)
radius
- The distance in selected units (see UserPreferences.Unit
), either miles or meters.GasStationManager.GasStationManagerException
- when: radius
is equal or less than GasStationManager.GasStationsOnRouteOptions.MIN_RADIUS_IN_MILES
and bigger than GasStationManager.GasStationsOnRouteOptions.MAX_RADIUS_IN_MILES
miles.public void setDistance(double distance)
distance
- distance in selected Units, default as mile.GasStationManager.GasStationManagerException
- when: distance
is equal or less than GasStationManager.GasStationsOnRouteOptions.MIN_DISTANCE_IN_MILES
and bigger than GasStationManager.GasStationsOnRouteOptions.MAX_DISTANCE_IN_MILES
miles.public void setUnits(UserPreferences.Unit units)
units
- An instance of UserPreferences.Unit
.Copyright © 2013-2018 INRIX, Inc. All Rights Reserved.