public static class AlertsManager.RouteAlertOptions extends Object
Constructor and Description |
---|
RouteAlertOptions(RouteManager.RequestRouteOptions routeOptions,
long interval)
Initializes a new instance of the
AlertsManager.RouteAlertOptions class
with route request options and an alert interval. |
RouteAlertOptions(RouteManager.RequestRouteOptions routeOptions,
long interval,
IFilter<Incident> filter)
Initializes a new instance of the
AlertsManager.RouteAlertOptions class
with route request options, an alert interval, and incidents filter. |
Modifier and Type | Method and Description |
---|---|
int |
getCalculationStartDistance() |
int |
getMaxLookAheadDistance()
Gets the max distance value.
|
int |
getMinLookAheadDistance() |
void |
setAtLocationTolerance(int tolerance)
Set the "at location" tolerance in meters.
|
void |
setCalculationStartDistance(int calculationStartDistance) |
T |
setComparator(Comparator<M> value)
Sets the incident comparator which will be used to sort incidents before
returning a set of incidents.
|
T |
setFilter(IFilter<M> value)
Sets the filter that filters out incidents.
|
T |
setForwardConeAngle(float value)
Sets the angle of the cone to search ahead for incidents.
|
T |
setInterval(long value)
Sets the desired notification interval in seconds.
|
void |
setMaxLookAheadDistance(int maxLookAheadDistance)
Sets the max distance.
|
void |
setMinLookAheadDistance(int minLookAheadDistance) |
void |
setOnRouteTolerance(int tolerance)
Set the "on route" tolerance in meters.
|
AlertsManager.RouteAlertOptions |
setParkingAlertOptions(AlertsManager.ParkingAlertOptions parkingAlertOptions)
Set the options for requesting and firing parking alerts.
|
void |
setRetryCount(int retryCount)
Sets the number of times to retry route request in case of failures.
|
AlertsManager.RouteAlertOptions |
setRouteOptions(RouteManager.RequestRouteOptions routeOptions)
Set the options for requesting routes.
|
T |
setSpeedFactor(float value)
Sets the speed factor.
|
String |
toString() |
public RouteAlertOptions(RouteManager.RequestRouteOptions routeOptions, long interval)
AlertsManager.RouteAlertOptions
class
with route request options and an alert interval.routeOptions
- Options for requesting routes.interval
- The alert interval. See setInterval(long)
.public RouteAlertOptions(RouteManager.RequestRouteOptions routeOptions, long interval, IFilter<Incident> filter)
AlertsManager.RouteAlertOptions
class
with route request options, an alert interval, and incidents filter.routeOptions
- Options for requesting routes.interval
- The alert interval. See setInterval(long)
.filter
- The incidents filter. See setFilter(com.inrix.sdk.IFilter<M>)
.public AlertsManager.RouteAlertOptions setRouteOptions(RouteManager.RequestRouteOptions routeOptions)
routeOptions
- Options for requesting routes.AlertsManager.RouteAlertOptions
class.AlertsManager.AlertsManagerException
- Thrown when routeOptions
is null.public AlertsManager.RouteAlertOptions setParkingAlertOptions(AlertsManager.ParkingAlertOptions parkingAlertOptions)
parkingAlertOptions
- Options for requesting parking information.AlertsManager.RouteAlertOptions
class.AlertsManager.AlertsManagerException
- Thrown when parkingAlertOptions
is null
.public void setRetryCount(int retryCount)
AlertsManagerConfig.getRetryCount()
.retryCount
- Number of retries.public void setOnRouteTolerance(int tolerance)
AlertsManager.OnRouteStatus.OFF_ROUTE
will be triggered.tolerance
- The tolerance in meters that is considered "on route".AlertsManager.AlertsManagerException
- When the value is less than or equal to zero.public void setAtLocationTolerance(int tolerance)
AlertsManager.OnRouteStatus
will be triggered.tolerance
- The tolerance in meters that is considered at a location.AlertsManager.AlertsManagerException
- When the value is less than or equal to zero.public T setSpeedFactor(float value)
value
- The speed factor, which should be positive number.
Default value is AlertsManagerConfig.getSpeedFactor()
.AlertsManager.AlertsManagerException
- Thrown when the speed factor is invalid.public T setComparator(Comparator<M> value)
value
- The incident comparator.public T setFilter(IFilter<M> value)
value
- The incident filter.public T setInterval(long value)
value
- The alert notification interval in seconds.AlertsManager.AlertsManagerException
- When the interval value is invalid.public T setForwardConeAngle(float value)
AlertsManagerConfig.getForwardConeAngle()
degrees.
Valid values must fall between FORWARD_CONE_ANGLE_MIN
and FORWARD_CONE_ANGLE_MAX
.value
- The forward cone angle value in degrees.AlertsManager.IncidentAlertOptions
class.AlertsManager.AlertsManagerException
- When the forward cone angle is out of range.public int getMaxLookAheadDistance()
public void setMaxLookAheadDistance(int maxLookAheadDistance)
maxLookAheadDistance
- The distance value in meters.public int getMinLookAheadDistance()
public void setMinLookAheadDistance(int minLookAheadDistance)
public int getCalculationStartDistance()
public void setCalculationStartDistance(int calculationStartDistance)
Copyright © 2013-2018 INRIX, Inc. All Rights Reserved.