EMAPI.Router.VehicleParams

Class vehicle parameters taken into account during routes calculating.

All cost which was set in a dirver parameters should be provided in currency which was specified while prescribing an itinerary (by default in PLN)

Summary
EMAPI.Router.VehicleParamsClass vehicle parameters taken into account during routes calculating.
Properties
name{String} Vehicle name.
vehicleType{Integer} The type of vehicle (default 0).
ignoreFuel{Boolean} Information about ignoring the cost of fuel during the routing (default true).
fixedCost{Float} Fixed cost of a single vehicle trip (default 0.00).
costPerKilometer{Float} The cost of 1 km of the route travelled by the vehicle (default 0.00).
costPerHour{Float} The cost of one hour of vehicle travel (default 0.00).
tollRoadPerKilometer{Float} The cost of 1 km toll road travelled by the vehicle (default 0.00).
tankCapacity{Float} The capacity of vehicle’s fuel tank (default 0).
fuelCost{Float} The cost of 1 litre of fuel used by the vehicle (default 0.00).
refuelTime{Float} Czas tankowania pojazdu będący ułamkową częścią doby, np.
vehicleWeight{Float} Vehicle weight in tonnes (default 0).
vehicleLength{Float} Vehicle length in meters (default 0).
vehicleHeight{Float} Vehicle height in meters (default 0).
vehicleWidth{Float} Vehicle width in meters (default 0).
vehicleCapacity{Float} Vehicle cargo capacity in cubic meters (default 0).
vehicleLoadCapacity{Float} The maximum weight of the load of the vehicle in tonnes (default 0).
shippingTime{Float} Time boarding of the ferry which is a fractional part of the day, e.g.
borderPassTime{Float} The waiting time at the border crossing which is a fractional part of the day e.g.
routeOptions{EMAPI.ArrayObjects} The parameters of a moving vehicle on the different types.
vehicleWeightPerAxle{Float} Pressure per axle in tones (default 0).
vehicleLoadType{Integer} Information on dangerous goods carried by the vehicle (default 0).
vehicleAxles{Integer} The number of axles (default 2).
vehicleEmission{Integer} The emission standard (domyślnie 5).
vehicleDPF{Boolean} Information whether the vehicle has a particulate filter (default false).
Functions
EMAPI.Router.VehicleParamsConstructor of new instance EMAPI.Router.VehicleParams class.
destroyDestroys object of EMAPI.Router.VehicleParams class.

Properties

name

{String} Vehicle name.

vehicleType

{Integer} The type of vehicle (default 0).

  • 0 = passenger car
  • 1 = transport truck
  • 2 = motorcycle
  • 3 = pedestrain
  • 4 = bicycle
  • 5 = delivery truck
  • 6 = residental vehicle
  • 7 = taxi
  • 8 = public bus
  • 9 = straight truck
  • 10 = non-standard vehicle

ignoreFuel

{Boolean} Information about ignoring the cost of fuel during the routing (default true).

fixedCost

{Float} Fixed cost of a single vehicle trip (default 0.00).

costPerKilometer

{Float} The cost of 1 km of the route travelled by the vehicle (default 0.00).

costPerHour

{Float} The cost of one hour of vehicle travel (default 0.00).

tollRoadPerKilometer

{Float} The cost of 1 km toll road travelled by the vehicle (default 0.00).

tankCapacity

{Float} The capacity of vehicle’s fuel tank (default 0).

fuelCost

{Float} The cost of 1 litre of fuel used by the vehicle (default 0.00).

refuelTime

{Float} Czas tankowania pojazdu będący ułamkową częścią doby, np.  1/24 oznacza 01:00:00 (domyślnie 0).

vehicleWeight

{Float} Vehicle weight in tonnes (default 0).

vehicleLength

{Float} Vehicle length in meters (default 0).

vehicleHeight

{Float} Vehicle height in meters (default 0).

vehicleWidth

{Float} Vehicle width in meters (default 0).

vehicleCapacity

{Float} Vehicle cargo capacity in cubic meters (default 0).

vehicleLoadCapacity

{Float} The maximum weight of the load of the vehicle in tonnes (default 0).

shippingTime

{Float} Time boarding of the ferry which is a fractional part of the day, e.g.  1/24 means 01:00:00 (default 0).

borderPassTime

{Float} The waiting time at the border crossing which is a fractional part of the day e.g.  1/24 means 01:00:00 (default 0).

routeOptions

{EMAPI.ArrayObjects} The parameters of a moving vehicle on the different types.  It’s an array of 15 objects EMAPI.Router.RoadParams class managed by an object of EMAPI.ArrayObjects class.

vehicleWeightPerAxle

{Float} Pressure per axle in tones (default 0).

vehicleLoadType

{Integer} Information on dangerous goods carried by the vehicle (default 0).

  • 0 = lack of dangerous materials
  • 1 = dangerous materials
  • 2 = explosive or flammable materials
  • 4 = materials that can cause a water contamination

vehicleAxles

{Integer} The number of axles (default 2).

vehicleEmission

{Integer} The emission standard (domyślnie 5).

vehicleDPF

{Boolean} Information whether the vehicle has a particulate filter (default false).

Functions

EMAPI.Router.VehicleParams

Constructor of new instance EMAPI.Router.VehicleParams class.

Parameters

options{Object} An object with additional parameters of class instance.

destroy

destroy: function()

Destroys object of EMAPI.Router.VehicleParams class.

Assistant class for managing the JavaScript objects array.
destroy: function()
Destroys object of EMAPI.Router.VehicleParams class.
Class of suitable parameters type of roads taken into account during the routes calculating
Close