com.inrix.sdk

Class AlertsManager.IncidentAlertOptions

java.lang.Object

com.inrix.sdk.AlertsManager.IncidentAlertOptions

Enclosing class:

AlertsManager

public static final class AlertsManager.IncidentAlertOptions
extends Object

Options for AlertsManager.createIncidentAlert(IncidentAlertOptions, IIncidentsAlertListener, boolean) .

Constructor Summary

Constructors

Constructor and Description
IncidentAlertOptions(long interval) Initializes a new instance of the AlertsManager.IncidentAlertOptions class.
IncidentAlertOptions(long interval, IFilter<Incident> filter, AlertsManagerConfig config) Initializes a new instance of the AlertsManager.IncidentAlertOptions class.
IncidentAlertOptions(long interval, IFilter<Incident> filter, float forwardConeAngle) Initializes a new instance of the AlertsManager.IncidentAlertOptions class.

Method Summary

Methods

Modifier and Type	Method and Description
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.
AlertsManager.IncidentAlertOptions	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.
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

IncidentAlertOptions

public IncidentAlertOptions(long interval)

Initializes a new instance of the AlertsManager.IncidentAlertOptions class.

Parameters:

interval - Alert interval in seconds. See setInterval(long).

IncidentAlertOptions

public IncidentAlertOptions(long interval,
                    IFilter<Incident> filter,
                    float forwardConeAngle)

Initializes a new instance of the AlertsManager.IncidentAlertOptions class.

Parameters:

interval - Alert interval in seconds. See setInterval(long).

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

forwardConeAngle - The angle of the cone we want to filter incidents. See AlertsManager.IncidentAlertOptions.setForwardConeAngle(float).

IncidentAlertOptions

public IncidentAlertOptions(long interval,
                    IFilter<Incident> filter,
                    AlertsManagerConfig config)

Initializes a new instance of the AlertsManager.IncidentAlertOptions class.

Parameters:

interval - Alert interval in seconds. See setInterval(long).

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

config - An instance of the AlertsManagerConfig.

Method Detail

setForwardConeAngle

public AlertsManager.IncidentAlertOptions setForwardConeAngle(float value)

Sets the angle of the cone to search ahead for incidents.

By default this angle is set to AlertsManagerConfig.getForwardConeAngle() degrees. Valid values must fall between AlertsManager.IncidentAlertOptions.FORWARD_CONE_ANGLE_MIN and AlertsManager.IncidentAlertOptions.FORWARD_CONE_ANGLE_MAX.

Parameters:

value - The forward cone angle value in degrees.

Returns:

This instance of the AlertsManager.IncidentAlertOptions class.

Throws:

AlertsManager.AlertsManagerException - When the forward cone angle is out of range.

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.