com.inrix.sdk

Class CameraManager.CamerasInBoxOptions

java.lang.Object

com.inrix.sdk.CameraManager.CamerasInBoxOptions

Enclosing class:

CameraManager

public static final class CameraManager.CamerasInBoxOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
CamerasInBoxOptions(GeoPoint corner1, GeoPoint corner2) Initializes a new instance of the CameraManager.CamerasInBoxOptions class with the two corners of the rectangular region.

Method Summary

Methods

Modifier and Type	Method and Description
CameraManager.CamerasInBoxOptions	setCorner1(GeoPoint value) Sets the first corner of the region.
CameraManager.CamerasInBoxOptions	setCorner2(GeoPoint value) Sets the second corner of the region, which is diagonally opposite the first corner.
CameraManager.CamerasInBoxOptions	setOutOfServiceCamerasExcluded(boolean value) Sets a value indicating whether the out-of-service cameras are returned in the result.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CamerasInBoxOptions

public CamerasInBoxOptions(GeoPoint corner1,
                   GeoPoint corner2)

Initializes a new instance of the CameraManager.CamerasInBoxOptions class with the two corners of the rectangular region.

Parameters:

corner1 - The first corner of the region in which to get data.

corner2 - The second corner of the region in which to get data, which diagonally opposed corner1.

Method Detail

setCorner1

public CameraManager.CamerasInBoxOptions setCorner1(GeoPoint value)

Sets the first corner of the 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 first corner of the region in which to get data.

Returns:

This instance of the CameraManager.CamerasInBoxOptions class.

Throws:

CameraManager.CamerasManagerException - when value is not a valid corner position.

setCorner2

public CameraManager.CamerasInBoxOptions setCorner2(GeoPoint value)

Sets the second corner of the region, which is diagonally opposite the first corner.

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 second corner of the region in which to get data.

Returns:

This instance of the CameraManager.CamerasInBoxOptions class.

Throws:

CameraManager.CamerasManagerException - when value is not a valid corner position.

setOutOfServiceCamerasExcluded

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

toString

public String toString()

Overrides:

toString in class Object