com.inrix.sdk

Class AlertsManager.ParkingAlertOptions

java.lang.Object

com.inrix.sdk.AlertsManager.ParkingAlertOptions

Enclosing class:

AlertsManager

public static class AlertsManager.ParkingAlertOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ParkingAlertOptions() Initializes a new instance of the AlertsManager.ParkingAlertOptions class with default params.
ParkingAlertOptions(int radius) Initializes a new instance of the AlertsManager.ParkingAlertOptions class with radius.
ParkingAlertOptions(int radius, int maxResultCount, boolean isRecurring) Initializes a new instance of the AlertsManager.ParkingAlertOptions class with radius and max results count.

Method Summary

Methods

Modifier and Type	Method and Description
AlertsManager.ParkingAlertOptions	setIsRecurring(boolean value) Sets whether this ParkingAlertOptions is a recurring alert or not.
AlertsManager.ParkingAlertOptions	setMaxResultCount(int value) Sets the number of max count of parking results.
AlertsManager.ParkingAlertOptions	setRadius(int value) Sets the radius of the circular region in which to get parking lot data.
AlertsManager.ParkingAlertOptions	setSpeedFactor(float value) Sets the speed factor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParkingAlertOptions

public ParkingAlertOptions()

Initializes a new instance of the AlertsManager.ParkingAlertOptions class with default params.

ParkingAlertOptions

public ParkingAlertOptions(int radius)

Initializes a new instance of the AlertsManager.ParkingAlertOptions class with radius.

Parameters:

radius - The radius. See AlertsManager.ParkingAlertOptions.setRadius(int).

ParkingAlertOptions

public ParkingAlertOptions(int radius,
                   int maxResultCount,
                   boolean isRecurring)

Initializes a new instance of the AlertsManager.ParkingAlertOptions class with radius and max results count.

Parameters:

radius - The radius. See AlertsManager.ParkingAlertOptions.setRadius(int).

maxResultCount - The max result count. See AlertsManager.ParkingAlertOptions.setMaxResultCount(int).

isRecurring - true if the alert is recurring, false otherwise.

Method Detail

setSpeedFactor

public AlertsManager.ParkingAlertOptions setSpeedFactor(float value)

Sets the speed factor. This value is used to dynamically determine 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.

setRadius

public AlertsManager.ParkingAlertOptions setRadius(int value)

Sets the radius of the circular region in which to get parking lot data.

Parameters:

value - The radius of the circular bounding area from which return data. The units are meters.

Returns:

This instance of the AlertsManager.ParkingAlertOptions class.

Throws:

AlertsManager.AlertsManagerException - when the specified radius value is invalid.

setMaxResultCount

public AlertsManager.ParkingAlertOptions setMaxResultCount(int value)

Sets the number of max count of parking results.
Must be positive number.

Parameters:

value - The the number of max count of parking results.

Returns:

This instance of the class.

Throws:

AlertsManager.AlertsManagerException - When the number value is invalid.

setIsRecurring

public AlertsManager.ParkingAlertOptions setIsRecurring(boolean value)

Sets whether this ParkingAlertOptions is a recurring alert or not.

Parameters:

value - true if the alert is recurring, false otherwise.

Returns:

This instance of the class.