v5 v4

Class: LogisticsRouting

cercalia.service.LogisticsRouting

new cercalia.service.LogisticsRouting(options)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 7

Routing Logistics Service constructor

Name Type Description
options
Name Type Description
destination cercalia.LonLat | cercaliax.service.RoutingStep

Destination coordinates.
lang string

Report language (only if report=true).
mindist boolean | undefined optional

Minimum substage distance, in meters (default value 1000). The larger this distance , the smaller the number of substages.
origin cercalia.LonLat | cercaliax.service.RoutingStep

Origin coordinates.
reorder boolean | undefined optional

Specify if you want to reorder or not the route stops, to get the faster/shorter route. Maximum 10 stop points.
report boolean | undefined optional

Get the textual route report (if not, gets a faster response). Default 0.
steps Array.<cercalia.LonLat> | Array.<cercaliax.service.RoutingStep> | undefined optional

Array with stop points coordinates (optional).
tolerance number | undefined optional

Route geometry generalization, in meters (if =0, returns the original geometry). Default value, 5 (meters).
toll boolean | undefined optional

Specify if you need to get the toll roads cost for the route. Currently only avaliable for Spain, Portugal and Andorra.
weight string | undefined optional

Route type: time (faster), distance (shorter), money (toll free route). Default value: time.
vweight number | undefined optional

Total maximum weight.
vaxleweight number | undefined optional

Maximum axle weight.
vheight number | undefined optional

Maximum height.
vlength number | undefined optional

Maximum length.
vwidth number | undefined optional

Maximum width.
vmaxvel number | undefined optional

Maximum speed.
trstart number | undefined optional

Restriction by date.

Methods

calculateRoute(callbackFn)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 181

Calculates the route specifying a callback function to be executed when obtains the response

Name Type Description
callbackFn function

clear()

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 164

Resets the values to null

getClass(){string}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 349

Returns the object type.

getTRStart(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 149

Get the restriction time start.

Returns:
Restriction time start.

getVAxleWeight(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 69

Get the vehicle axel weight.

Returns:
Vehicle axel weight.

getVHeight(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 85

Get the vehicle height.

Returns:
Vehicle height.

getVLength(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 101

Get the vehicle length.

Returns:
Vehicle length.

getVMaxVel(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 133

Get the vehicle maximum speed.

Returns:
Vehicle maximum speed.

getVWeight(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 53

Get the vehicle weight.

Returns:
Vehicle weight.

getVWidth(){number}

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 117

Get the vehicle width.

Returns:
Vehicle width.

setTRStart(trstart)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 157

Set the restriction time start.

Name Type Description
trstart number

Restriction time start.

setVAxleWeight(vaxleweight)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 77

Set the vehicle axel weight.

Name Type Description
vaxleweight number

Vehicle axel weight.

setVHeight(vheight)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 93

Set the vehicle height.

Name Type Description
vheight number

Vehicle height.

setVLength(vlength)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 109

Set the vehicle length.

Name Type Description
vlength number

Vehicle length.

setVMaxVel(vmaxvel)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 141

Set the vehicle maximum speed.

Name Type Description
vmaxvel number

Vehicle maximum speed.

setVWeight(vweight)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 61

Set the vehicle weight.

Name Type Description
vweight number

Vehicle weight.

setVWidth(vwidth)

temp/jsdocinputdirs/cercalia.service.logisticsrouting.js, line 125

Set the vehicle width.

Name Type Description
vwidth number

Vehicle width.