com.inrix.sdk

Class IncidentsManager.IncidentRadiusOptions

java.lang.Object

com.inrix.sdk.IncidentsManager.IncidentRadiusOptions

Enclosing class:

IncidentsManager

public static final class IncidentsManager.IncidentRadiusOptions
extends Object

Contains options that specify which incidents in a box to return.

See Also:

IncidentsManager.getIncidentsInRadius(com.inrix.sdk.IncidentsManager.IncidentRadiusOptions, com.inrix.sdk.IncidentsManager.IIncidentsResponseListener)

Constructor Summary

Constructors

Constructor and Description
IncidentRadiusOptions(GeoPoint center, double radius) Initializes a new instance of the IncidentsManager.IncidentRadiusOptions class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
IncidentsManager.IncidentRadiusOptions	setCenter(GeoPoint center) Sets the center of the circular bounding area from which to get data.
T	setIncidentSource(int incidentSource) Sets the requested source of the incidents.
T	setIncidentType(int incidentType) Sets the type of incidents to be returned.
T	setOutputFields(int value) Sets the output fields of the incident.
IncidentsManager.IncidentRadiusOptions	setRadius(double radius) Sets the radius of the circular bounding area from which to return data.
T	setSeverity(Integer[] severity) Filters incident reports based on severity level.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IncidentRadiusOptions

public IncidentRadiusOptions(GeoPoint center,
                     double radius)

Initializes a new instance of the IncidentsManager.IncidentRadiusOptions class.

The units for the radius is either meters or miles depending on what is set in UserPreferences.getSettingUnits(). The default units are set using UserPreferences.

Parameters:

center - The center of the circular region from which to get the incidents.

radius - The radius of the circular region.

Throws:

IncidentsManager.IncidentsManagerException - Thrown when center or radius is invalid.

Method Detail

setCenter

public IncidentsManager.IncidentRadiusOptions setCenter(GeoPoint center)

Sets the center of the circular bounding area from which to get data. Any features that are fully or partially enclosed within the bounding area are selected.

Parameters:

center - The center of the region.

Returns:

This instance of the class.

Throws:

IncidentsManager.IncidentsManagerException - when center is invalid.

setRadius

public IncidentsManager.IncidentRadiusOptions setRadius(double radius)

Sets the radius of the circular bounding area from which to return data. Any features that are fully or partially enclosed within the bounding area are selected.

Parameters:

radius - The radius of the bounding area, which must be a positive integer. The units are set using UserPreferences.getSettingUnits().

Returns:

This instance of the class.

Throws:

IncidentsManager.IncidentsManagerException - when radius is invalid.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setIncidentType

public T setIncidentType(int incidentType)

Sets the type of incidents to be returned. The default is "ALL" (see IncidentsManager.INCIDENT_RESULT_TYPE_ALL). Multiple types can be specified by using the "or" operator.

Parameters:

incidentType - One or more incident types.

Returns:

This instance of the class.

setIncidentSource

public T setIncidentSource(int incidentSource)

Sets the requested source of the incidents.

A value of IncidentsManager.INCIDENT_SOURCE_INRIXONLY specifies that incidents are compiled from non-commercial sources, such as flow incidents that are generated programmatically from Inrix traffic information or planned construction incidents. A value of IncidentsManager.INCIDENT_SOURCE_COMMUNITY specifies that incidents come from community sources, such as incidents submitted through mobile devices. The default is IncidentsManager.INCIDENT_SOURCE_ALL. *

Parameters:

incidentSource - The source of the incident information.

Returns:

This instance of the class.

setOutputFields

public T setOutputFields(int value)

Sets the output fields of the incident.

Parameters:

value - Output fields. Can be IncidentsManager.INCIDENT_OUTPUT_FIELD_ALL or any combination of the following:

• IncidentsManager.INCIDENT_OUTPUT_FIELD_ID
• IncidentsManager.INCIDENT_OUTPUT_FIELD_VERSION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_TYPE
• IncidentsManager.INCIDENT_OUTPUT_FIELD_SEVERITY
• IncidentsManager.INCIDENT_OUTPUT_FIELD_EVENT_CODE
• IncidentsManager.INCIDENT_OUTPUT_FIELD_LATLONG
• IncidentsManager.INCIDENT_OUTPUT_FIELD_IMPACTING
• IncidentsManager.INCIDENT_OUTPUT_FIELD_START_TIME
• IncidentsManager.INCIDENT_OUTPUT_FIELD_END_TIME
• IncidentsManager.INCIDENT_OUTPUT_FIELD_DELAY_IMPACT
• IncidentsManager.INCIDENT_OUTPUT_FIELD_PARAMETERIZED_DESCRIPTION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_SHORT_DESCRIPTION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_FULL_DESCRIPTION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_HEAD_TAIL

Returns:

Current instance.

setSeverity

public T setSeverity(Integer[] severity)

Filters incident reports based on severity level. This value can be in the range of IncidentsManager.INCIDENT_SEVERITY_0- IncidentsManager.INCIDENT_SEVERITY_4, with IncidentsManager.INCIDENT_SEVERITY_4 indicating the highest severity. Multiple severity values can be specified. All severities are returned by default.

Parameters:

severity - The set of incident severities.

Returns:

This instance of the class.

Throws:

IncidentsManager.IncidentsManagerException - when severity is invalid.