{"id":81,"date":"2020-05-12T09:12:09","date_gmt":"2020-05-12T07:12:09","guid":{"rendered":"http:\/\/wiki.hogs.live\/?page_id=81"},"modified":"2021-01-21T08:04:24","modified_gmt":"2021-01-21T07:04:24","slug":"wyznaczanie-trasy-2","status":"publish","type":"page","link":"https:\/\/wiki.hogs.live\/en\/wyznaczanie-trasy-2\/","title":{"rendered":"calculateRoute"},"content":{"rendered":"

mode=calculateRoute<\/code><\/p><\/blockquote>\n\n\n\n

Iframe mode that allows route plotting.<\/p>\n\n\n\n

<iframe src=\"https:\/\/iframe.hogs.live?authToken=<authToken>&mode=calculateRoute&options=<options>\"><\/iframe> <\/code><\/p><\/blockquote>\n\n\n\n

Options<\/h3>\n\n\n\n

interface<\/em> CalculateRouteOptions {
  waypoints: Waypoint[];
  vehicleSpec: VehicleSpec;
  routeSettings: CustomRouteSettings;
  calculatorSettings: CalculatorSettings<\/em>;<\/code>
  mode: RouteKind;
  alternatives?: boolean<\/em>;<\/code>
  showInfo?: boolean<\/em>;<\/code>
  link?: string<\/em>;<\/code>
} <\/code><\/p><\/blockquote>\n\n\n\n

Alternatives<\/strong> parameter causes the route querry to return with alternative routes. Alternative routes are not visually represented in the iframe.<\/p>\n\n\n\n

Waypoints<\/h4>\n\n\n\n

interface<\/em> Waypoint {
  lat: string<\/em>;
  lat: string<\/em>;
  passThrough?: boolean<\/em>;
}<\/code><\/p><\/blockquote>\n\n\n\n

Only intermediary points can have passThrough: true value<\/strong>.<\/p>\n\n\n\n

VehicleSpec<\/h4>\n\n\n\n

interface<\/em> VehicleSpec {
  truckHeight: string<\/em>;
  truckWidth: string<\/em>;
  truckLength: string<\/em>;
  truckWeight: string<\/em>;
  axisNumberTractor: string<\/em>;
  euroClass: EuroClass;
  heightAboveFirstAxle: string<\/em>;
  vehicleType: VehicleType;
  weightPerAxle: string<\/em>;
  trailerHeight: string<\/em>;
  axisNumberTrailer: string<\/em>;
} <\/code><\/p><\/blockquote>\n\n\n\n

enum<\/em> EuroClass {
  EURO_I = \"1\",
  EURO_II = \"2\",
  EURO_III = \"3\",
  EURO_IV = \"4\",
  EURO_V = \"5\",
  EURO_VI = \"6\",
  EURO_EEV = \"7\",
  Electric_Vehicles = \"8\"
} <\/code><\/p><\/blockquote>\n\n\n\n

enum<\/em> VehicleType {
  truckTractor = \"truckTractor\",
  tandem = \"tandem\",
  solo = \"solo\",
  bus = \"bus\"
  car = \"car\"
} <\/code><\/p><\/blockquote>\n\n\n\n

Attention!<\/h4>\n\n\n\n

Choosing car<\/strong> (passenger car) type will switch from articulated vehicle route plotting to passener car plotting and all parameters provided in VehicleSpec<\/strong> will not be considered. Only axisNumberTractor, euroClass, truckHeight, truckWeight<\/strong> parameters are usig when calculating road toll. Parameters are optional and the only default value is the number of axis (axisNumberTractor) \u2013 2.<\/p>\n\n\n\n
Parameter<\/strong><\/td>Example<\/strong><\/td>Default value<\/strong><\/td>Comments<\/strong><\/td><\/tr>
truckHeight <\/td> 4.00 <\/td> 4.00 <\/td> tractor height (m) <\/td><\/tr>
truckWidth <\/td> 2.5 <\/td> 2.55 <\/td> set width (m) <\/td><\/tr>
truckLength <\/td> 16.5 <\/td> 16.5 <\/td> set length (m) <\/td><\/tr>
truckWeight <\/td> 40.00 <\/td> 40.00 <\/td> total set weight (t) <\/td><\/tr>
axisNumberTractor <\/td> 2 <\/td> 2 <\/td> tractor axles number <\/td><\/tr>
euroClass <\/td>6<\/td>6<\/td> exhaust fumes norm <\/td><\/tr>
heightAboveFirstAxle <\/td> 4.00 <\/td> 4.00 <\/td> height above first axle (m) <\/td><\/tr>
vehicleType <\/td> truckTractor <\/td> truckTractor <\/td>Vehicle type - if a vehicle without trailer is chosen the trailerHeight<\/strong> and axisNumberTrailer<\/strong> parameters are ignored.<\/td><\/tr>
weightPerAxle <\/td> 10 <\/td> 10 <\/td>axle load<\/td><\/tr>
trailerHeight <\/td> 4.00 <\/td> 4.00 <\/td> trailer height (m) <\/td><\/tr>
axisNumberTrailer <\/td> 3 <\/td> 3 <\/td> trailer axles number <\/td><\/tr><\/tbody><\/table>\n\n\n\n

CustomRouteSettings <\/h4>\n\n\n\n

interface<\/em> CustomRouteSettings {
  departure?: string<\/em>;
  avoidPayments?: boolean<\/em>;
  avoidCountries?: string<\/em>;
  shippedHazardousGoods?: ShippedHazardousGoods;
  avoidFerries?: RouteFeatureWeight;
  avoidMotorways?: RouteFeatureWeight;
  currency?: string<\/em>;
} <\/code><\/p><\/blockquote>\n\n\n\n

enum<\/em> ShippedHazardousGoods {
  explosive = \"explosive\",
  gas = \"gas\",
  flammable = \"flammable\",
  combustible = \"combustible\",
  organic = \"organic\",
  poison = \"poison\",
  radioActive = \"radioActive\",
  corrosive = \"corrosive\",
  poisonousInhalation = \"poisonousInhalation\",
  harmfulToWater = \"harmfulToWater\",
  other = \"other\"
} <\/code><\/p><\/blockquote>\n\n\n\n

enum<\/em> RouteFeatureWeight {
  STRICT_EXCLUDE = -3,
  SOFT_EXCLUDE = -2,
  AVOID = -1,
  NORMAL = 0
}<\/code><\/p><\/blockquote>\n\n\n\n

Excluding ferries or highways may have different weight:<\/p>\n\n\n\n