Class: RoadSurfaceRouteService

Extends

• alk.service.Service

Methods

get(opts_or_callback, responseCallback)

This method performs a call to the Road Surface Route Service to return a route.

Name	Type	Description
opts_or_callback	alkx.RoadSurfaceRouteServiceOptions | null | function	This parameter contains any options to override or extend the options set in the construction of this object for the call. Attribute Type Description apiKey string This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers. dataset alk.val.Dataset | number | string The option contains the Dataset parameter for the Service. This option specifies an area dataset that may be pertinent to the request. region alk.val.Region | number | string This option tells the service in which region the retrieved data is to pertain. Some ALK Services switch underlying services due to this option. For instance, traffic data for North America and Europe may come from different underlying services. hostURL string This option contains the the host and port URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used. path string This option is the path part of the URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used. hourOffset number | string This option tells the service the hour offset in which to return image data or tiles. TODO: Better description. provider alk.val.Provider | number | string This option tells the service the provider in which to return image data or tiles. The options are Default or RC1. routePath Array.<Array.<number>> This option tells the service the route for which to get the road conditions. routeDuration number | string This option tells the service the duration route for which to get the road conditions.
responseCallback	function	The response handler.

getAttribution(opts_or_callback, responseCallback){*|undefined} inherited

This method performs a request to this configured service using the supplied options, options set on the constructor, and defaults to get the service's attribution, should it have one. This call results in Object, which may be a parsed JSON response.

Name	Type	Description
opts_or_callback	Object | function	This parameter contains any options that override options that are set on this object for this particular request.
responseCallback	function	This parameter is the function that handles the response.

getServiceOptions(options){Object} inherited

This method returns the base options that was used to create this Service object and override them with the given options;

Name	Type	Description
options	Object

Returns:

The combined options.

getURL(opt_options){string} inherited

Returns the URL for the service based on the given options, options set on the constructor, and defaults.

Name	Type	Description
options	Object	These options override any relevant options that are set on the object at its construction.

processResponse(options, obj){Object}

This call processes the response before it is given to the callback.

This particular method enhances the response from the ALK/PCM service and modifies it accordingly.

The response returned from the Road Surface Route Service returns an array of ol.Feature objects each containing a single LineString, which is a portion of the supplied 'routePath' option in the call.

Name	Type	Description
options	Object	The options that were given with the call combined with the base options used for the alk.service.RoadSurfaceRouteService.
obj	Object	The Array. response from the alk.service.RoadSurfaceRouteService.

Returns:

Containing the RoadSurfaceRouteServiceOptions and if a successful call also contains a FeatureCollection containing the line strings making up the collection.