com.inrix.sdk

Class CameraManager.CamerasInRadiusOptions

java.lang.Object

com.inrix.sdk.CameraManager.CamerasInRadiusOptions

Enclosing class:

CameraManager

public static final class CameraManager.CamerasInRadiusOptions
extends Object

Contains information used in filtering which traffic cameras are returned when retrieving traffic cameras in a circular region.

Constructor Summary

Constructors

Constructor and Description
CamerasInRadiusOptions(GeoPoint center, double radius) Initializes a new instance of CameraManager.CamerasInRadiusOptions class where the radius units depends on the user settings.

Method Summary

Methods

Modifier and Type	Method and Description
CameraManager.CamerasInRadiusOptions	setCenter(GeoPoint value) Sets the center point of the circular region.
CameraManager.CamerasInRadiusOptions	setOutOfServiceCamerasExcluded(boolean value) Sets a value indicating whether the out-of-service cameras are returned in the result.
CameraManager.CamerasInRadiusOptions	setRadius(double value) Sets the radius of the circular region.

Methods inherited from class java.lang.Object

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

Constructor Detail

CamerasInRadiusOptions

public CamerasInRadiusOptions(GeoPoint center,
                      double radius)

Initializes a new instance of CameraManager.CamerasInRadiusOptions class where the radius units depends on the user settings.

The units for the radius is either meters or miles depending on the settings that are set using UserPreferences.

Parameters:

center - The center of the region where the traffic cameras are located.

radius - The radius of the region where the traffic cameras are located.

Method Detail

setCenter

public CameraManager.CamerasInRadiusOptions setCenter(GeoPoint value)

Sets the center point of the circular region.

Northern latitudes are positive and southern latitudes are negative. Eastern hemisphere longitudes are positive and western hemisphere longitudes are negative. Longitudes in North America are negative. The latitude and longitude values are expressed using the WGS 84 datum.

Parameters:

value - The center of the region in which to get data.

Returns:

This instance of the CameraManager.CamerasInRadiusOptions class.

Throws:

CameraManager.CamerasManagerException - when the specified center point is invalid.

setRadius

public CameraManager.CamerasInRadiusOptions setRadius(double value)

Sets the radius of the circular region.

Any features that are fully or partially enclosed within the bounding area are selected. If the Units parameter is set to Metric, the radius is measured in meters; if Units is set to MILES, the radius is measured in miles.

Parameters:

value - The radius of the circular bounding area from which to return data.

Returns:

This instance of the CameraManager.CamerasInRadiusOptions class.

Throws:

CameraManager.CamerasManagerException - when the radius is less than or equal to zero.

setOutOfServiceCamerasExcluded

public CameraManager.CamerasInRadiusOptions setOutOfServiceCamerasExcluded(boolean value)

Sets a value indicating whether the out-of-service cameras are returned in the result. Default is false.

Parameters:

value - true to receive all camera, including out-of-service; false otherwise.

Returns:

Current instance.