com.inrix.sdk

Class CameraManager.CamerasOnRouteOptions

java.lang.Object

com.inrix.sdk.CameraManager.CamerasOnRouteOptions

Enclosing class:

CameraManager

public static final class CameraManager.CamerasOnRouteOptions
extends Object

Contains options for requesting cameras along the route, such as route points and distance in miles for cameras radius.

See Also:

CameraManager.getCamerasOnRoute(com.inrix.sdk.CameraManager.CamerasOnRouteOptions, com.inrix.sdk.CameraManager.IGetCamerasResponseListener)

Constructor Summary

Constructors

Constructor and Description
CamerasOnRouteOptions(Route route) Initializes a new instance of the CameraManager.CamerasOnRouteOptions class using route points.

Method Summary

Methods

Modifier and Type	Method and Description
CameraManager.CamerasOnRouteOptions	setCameraRadiusOnRoute(double radius) Sets the radius for cameras along the route.
CameraManager.CamerasOnRouteOptions	setOutOfServiceCamerasExcluded(boolean value) Sets a value indicating whether the out-of-service cameras are returned in the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

CamerasOnRouteOptions

public CamerasOnRouteOptions(Route route)

Initializes a new instance of the CameraManager.CamerasOnRouteOptions class using route points.

Parameters:

route - The route.

Throws:

CameraManager.CamerasManagerException - when the specified route are invalid.

Method Detail

setCameraRadiusOnRoute

public CameraManager.CamerasOnRouteOptions setCameraRadiusOnRoute(double radius)

Sets the radius for cameras along the route.

This parameter is optional.

Parameters:

radius - The radius for cameras along the route.

Returns:

This instance of the CameraManager.CamerasOnRouteOptions class.

Throws:

CameraManager.CamerasManagerException - when the specified radius is invalid.

setOutOfServiceCamerasExcluded

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