com.inrix.sdk

Class AlertsManager.RouteAlertOptions

java.lang.Object

com.inrix.sdk.AlertsManager.RouteAlertOptions

Enclosing class:

AlertsManager

public static class AlertsManager.RouteAlertOptions
extends Object

Contains options that specify how to create incident alerts related to a route.

See Also:

AlertsManager.createRouteAlert(com.inrix.sdk.AlertsManager.RouteAlertOptions, com.inrix.sdk.AlertsManager.RouteAlertCallback)

Constructor Summary

Constructors

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	setAtLocationTolerance(int tolerance) Set the "at location" tolerance in meters.
T	setComparator(Comparator<Incident> value) Sets the incident comparator which will be used to sort incidents before returning a set of incidents.
T	setFilter(IFilter<Incident> value) Sets the filter that filters out incidents.
T	setInterval(long value) Sets the desired notification interval in seconds.
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteAlertOptions

public RouteAlertOptions(RouteManager.RequestRouteOptions routeOptions,
                 long interval)

Initializes a new instance of the AlertsManager.RouteAlertOptions class with route request options and an alert interval.

Parameters:

routeOptions - Options for requesting routes.

interval - The alert interval. See setInterval(long).

RouteAlertOptions

public 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.

Parameters:

routeOptions - Options for requesting routes.

interval - The alert interval. See setInterval(long).

filter - The incidents filter. See setFilter(com.inrix.sdk.IFilter<com.inrix.sdk.model.Incident>).

Method Detail

setRouteOptions

public AlertsManager.RouteAlertOptions setRouteOptions(RouteManager.RequestRouteOptions routeOptions)

Set the options for requesting routes.

Parameters:

routeOptions - Options for requesting routes.

Returns:

This instance of the AlertsManager.RouteAlertOptions class.

Throws:

AlertsManager.AlertsManagerException - Thrown when routeOptions is null.

setParkingAlertOptions

public AlertsManager.RouteAlertOptions setParkingAlertOptions(AlertsManager.ParkingAlertOptions parkingAlertOptions)

Set the options for requesting and firing parking alerts.

Parameters:

parkingAlertOptions - Options for requesting parking information.

Returns:

This instance of the AlertsManager.RouteAlertOptions class.

Throws:

AlertsManager.AlertsManagerException - Thrown when parkingAlertOptions is null.

setRetryCount

public void setRetryCount(int retryCount)

Sets the number of times to retry route request in case of failures.
Default value: AlertsManagerConfig.getRetryCount().

Parameters:

retryCount - Number of retries.

setOnRouteTolerance

public void setOnRouteTolerance(int tolerance)

Set the "on route" tolerance in meters. If beyond this distance and tracking is in progress, AlertsManager.OnRouteStatus.OFF_ROUTE will be triggered.

Parameters:

tolerance - The tolerance in meters that is considered "on route".

Throws:

AlertsManager.AlertsManagerException - When the value is less than or equal to zero.

setAtLocationTolerance

public void setAtLocationTolerance(int tolerance)

Set the "at location" tolerance in meters. This is used to determine if the user is at a location along a route. If they are within this distance, the proper AlertsManager.OnRouteStatus will be triggered.

Parameters:

tolerance - The tolerance in meters that is considered at a location.

Throws:

AlertsManager.AlertsManagerException - When the value is less than or equal to zero.

toString

public String toString()

Overrides:

toString in class Object

setSpeedFactor

public T setSpeedFactor(float value)

Sets the speed factor. This value is used to dynamically determine incident distance depending on current speed. For instance, if the speed factor is set to 10 and the current speed is 60mph, the alert manager will request incidents in a 6 miles radius (60mph / 10 = 6). A higher speed will result in a bigger radius in which to request incidents.

Parameters:

value - The speed factor, which should be positive number. Default value is AlertsManagerConfig.getSpeedFactor().

Returns:

This instance of the class.

Throws:

AlertsManager.AlertsManagerException - Thrown when the speed factor is invalid.

setComparator

public T setComparator(Comparator<Incident> value)

Sets the incident comparator which will be used to sort incidents before returning a set of incidents.

Parameters:

value - The incident comparator.

Returns:

This instance of the class.

setFilter

public T setFilter(IFilter<Incident> value)

Sets the filter that filters out incidents.

Parameters:

value - The incident filter.

Returns:

This instance of the class.

setInterval

public T setInterval(long value)

Sets the desired notification interval in seconds.

The interval must be positive number.

Parameters:

value - The alert notification interval in seconds.

Returns:

This instance of the class.

Throws:

AlertsManager.AlertsManagerException - When the interval value is invalid.