PTV Truck Attributes

PTV provides truck attributes for most maps. The truck attributes are a subset of the segment attributes.
Following, those relevant for the RoadEditor / Truck attributes use case are described in the following sections.

Segment attributes overview

The following tables list all segment attributes and their usage in the request. See RoutingParameter ROADEDITOR_ADDITIONAL_OPTIONS for more information on the syntax. Please note that all segment attributes can also be configured by an XML profile which is referenced in the request. Such profiles adhere the structure of the xRoute XML Profile. You can find corresponding (partial) XML profiles below.

Segment attributes with a boolean parameter

The following segment attributes have a boolean parameter, that means they will be considered during route calculation if switched on. In order to override a profile or default setting, they can obtain the value false. They are divided into parameters which override a flag within the map data and those with (first and second table) and without (third table) a default meaning.

Parameters which override a flag within the map data (switched on by default)

These parameters correspond to profile attributes of the element SegmentSpecific within AdditionalDataRules:

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <Profile>
      <Routing majorVersion="2" minorVersion="0">
          <Course>
              <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                  <SegmentSpecific useSegmentLength="true" useFerryLength="true"
                         useFerryDuration="true" useUrbanAttribute="true"
                         useRampAttribute="true" useSpeed="true"
                         useBlockedForCarsAttribute="true" useBlockedForTrucksAttribute="true"
                         useTollForCarsAttribute="true" useTollForTrucksAttribute="true"/>
              </AdditionalDataRules>
          </Course>
    </Routing>
  </Profile>
Parameter name Profile element Profile attribute Description
SEGMENT_LENGTH SegmentSpecific useSegmentLength the length of the segment
IS_URBAN_AREA SegmentSpecific useUrbanAttribute segment is within an urban area
IS_RAMP SegmentSpecific useRampAttribute segment is a ramp
VNORMAL SegmentSpecific useSpeed the travel speed for the segment
BLOCKS_CAR SegmentSpecific useBlockedForCarsAttribute segment blocked for cars
BLOCKS_TRUCK SegmentSpecific useBlockedForTrucksAttribute segment blocked for trucks
HAS_TOLL_CAR SegmentSpecific useTollForCarsAttribute segment cars have to pay toll for
HAS_TOLL_TRUCK SegmentSpecific useTollForTrucksAttribute segment trucks have to pay toll for
FERRY_DURATION SegmentSpecific useFerryDuration the time of the ferry trip
FERRY_LENGTH SegmentSpecific useFerryLength the distance of the ferry trip

Parameters with a default meaning

These parameters correspond to the profile elements VehicleSpecific and Legacy within AdditionalDataRules:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <Profile>
                <Routing majorVersion="2" minorVersion="0">
                    <Course>
                        <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                            <Legacy>
                                <KeyValue key="HazardousToWaters" enabled="true"/>
                                <KeyValue key="HazardousGoods" enabled="true"/>
                                <KeyValue key="Combustibles" enabled="true"/>
                                <KeyValue key="HeavyLoad" enabled="true"/>
                                <KeyValue key="Vignette" enabled="true"/>
                            </Legacy>
                        </AdditionalDataRules>
                    </Course>
                </Routing>
            </Profile>
        
Parameter name Profile element Profile attribute(s) Description
HAZARDOUS_TO_WATERS Legacy/KeyValue key="HazardousToWaters" + enabled segment blocked for transportation of goods hazardous to waters
HAZARDOUS_GOODS Legacy/KeyValue key="HazardousGoods" + enabled segment blocked for transportation of hazardous goods
COMBUSTIBLES Legacy/KeyValue key="Combustibles" + enabled segment blocked for transports with potentially explosive hazards
HEAVYLOAD Legacy/KeyValue key="HeavyLoad" + enabled segment blocked for transportation of heavy goods
VIGNETTE Legacy/KeyValue key="Vignette" + enabled segment blocked if vehicles need a vignette for it

Parameters without a default meaning, i.e. the meaning will be defined by the data producer.

These parameters correspond to the profile element Legacy within AdditionalDataRules:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <Profile>
                <Routing majorVersion="2" minorVersion="0">
                    <Course>
                        <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                            <Legacy>
                                <KeyValue key="OptBlocks1" enabled="true"/>
                                <KeyValue key="OptBlocks2" enabled="true"/>
                                <KeyValue key="OptBlocks3" enabled="true"/>
                                <KeyValue key="OptBlocks4" enabled="true"/>
                                <KeyValue key="OptBlocks5" enabled="true"/>
                                <KeyValue key="OptBlocks6" enabled="true"/>
                                <KeyValue key="OptBlocks7" enabled="true"/>
                                <KeyValue key="OptBlocks8" enabled="true"/>
                                <KeyValue key="OptBlocks9" enabled="true"/>
                                <KeyValue key="OptBlocks10" enabled="true"/>
                            </Legacy>
                        </AdditionalDataRules>
                    </Course>
                </Routing>
            </Profile>
        
Parameter name Profile element Profile attribute(s)
OPT_BLOCKS1 Legacy/KeyValue key="OptBlocks1" + enabled
OPT_BLOCKS2 Legacy/KeyValue key="OptBlocks2" + enabled
OPT_BLOCKS3 Legacy/KeyValue key="OptBlocks3" + enabled
OPT_BLOCKS4 Legacy/KeyValue key="OptBlocks4" + enabled
OPT_BLOCKS5 Legacy/KeyValue key="OptBlocks5" + enabled
OPT_BLOCKS6 Legacy/KeyValue key="OptBlocks6" + enabled
OPT_BLOCKS7 Legacy/KeyValue key="OptBlocks7" + enabled
OPT_BLOCKS8 Legacy/KeyValue key="OptBlocks8" + enabled
OPT_BLOCKS9 Legacy/KeyValue key="OptBlocks9" + enabled
OPT_BLOCKS10 Legacy/KeyValue key="OptBlocks10" + enabled

Segment attributes with a malus parameter

The following segment attributes have a parameter which represents a malus, i.e. if present in ROADEDITOR_ADDITIONAL_OPTIONS all segments carrying the attribute in question will take the given malus. Each malus value must be in the range from -99 to 2501 (see RoutingParameter for more information on malus values). The attributes are divided into parameters with (first table) and without (second table) a default meaning.

It is recommended to use the following malus values:

Parameters with a default meaning

These parameters correspond to the profile elements VehicleSpecific and Legacy within AdditionalDataRules:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <Profile>
                <Routing majorVersion="2" minorVersion="0">
                    <Course>
                        <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                            <Legacy>
                                <KeyValue key="ScenicRouteType1" enabled="true" malus="-99"/>
                                <KeyValue key="ScenicRouteType2" enabled="true" malus="-99"/>
                                <KeyValue key="ScenicRouteType3" enabled="true" malus="-99"/>
                                <KeyValue key="ScenicRouteType4" enabled="true" malus="-99"/>
                                <KeyValue key="ScenicRouteType5" enabled="true" malus="-99"/>
                                <KeyValue key="Trailer" enabled="true" malus="2501"/>
                                <KeyValue key="ResidentialTrucks" enabled="true" malus="2501"/>
                                <KeyValue key="DeliveryTrucks" enabled="true" malus="2501"/>
                                <KeyValue key="PublicTrucks" enabled="true" malus="2501"/>
                                <KeyValue key="PreferredTrucks" enabled="true" malus="-99"/>
                                <KeyValue key="PreferredHazardousTrucks" enabled="true" malus="-99"/>
                            </Legacy>
                        </AdditionalDataRules>
                    </Course>
                </Routing>
            </Profile>
        
Parameter name Profile element Profile attribute(s) Description
SCENIC_ROUTE_TYPE1 Legacy/KeyValue key="ScenicRouteType1" + enabled + malus scenic route, type 1
SCENIC_ROUTE_TYPE2 Legacy/KeyValue key="ScenicRouteType2" + enabled + malus scenic route, type 2
SCENIC_ROUTE_TYPE3 Legacy/KeyValue key="ScenicRouteType3" + enabled + malus scenic route, type 3
SCENIC_ROUTE_TYPE4 Legacy/KeyValue key="ScenicRouteType4" + enabled + malus scenic route, type 4
SCENIC_ROUTE_TYPE5 Legacy/KeyValue key="ScenicRouteType5" + enabled + malus scenic route, type 5
TRAILER Legacy/KeyValue key="Trailer" + enabled + malus vehicles with trailer
RESIDENTIAL_TRUCKS Legacy/KeyValue key="ResidentialTrucks" + enabled + malus residentials only
DELIVERY_TRUCKS Legacy/KeyValue key="DeliveryTrucks" + enabled + malus delivery only
PUBLIC_TRUCKS Legacy/KeyValue key="PublicTrucks" + enabled + malus garbage trucks and/or maintenance vehicles only
PREFERRED_TRUCKS Legacy/KeyValue key="PreferredTrucks" + enabled + malus preferred route
PREFERRED_HAZARDOUS_TRUCKS Legacy/KeyValue key="PreferredHazardousTrucks" + enabled + malus preferred route for hazardous goods transports

Parameters without a default meaning, i.e. the meaning will be defined by the data producer

These parameters correspond to profile element Legacy within AdditionalDataRules:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <Profile>
                <Routing majorVersion="2" minorVersion="0">
                    <Course>
                        <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                            <Legacy>
                                <KeyValue key="OptMalus1" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus2" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus3" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus4" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus5" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus6" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus7" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus8" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus9" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus10" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus11" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus12" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus13" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus14" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus15" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus16" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus17" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus18" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus19" enabled="true" malus="2501"/>
                                <KeyValue key="OptMalus20" enabled="true" malus="2501"/>
                            </Legacy>
                        </AdditionalDataRules>
                    </Course>
                </Routing>
            </Profile>
        
Parameter name Profile element Profile attribute(s) Range
OPT_MALUS1 Legacy/KeyValue key="OptMalus1" + enabled + malus -99 to 2501
OPT_MALUS2 Legacy/KeyValue key="OptMalus2" + enabled + malus -99 to 2501
OPT_MALUS3 Legacy/KeyValue key="OptMalus3" + enabled + malus -99 to 2501
OPT_MALUS4 Legacy/KeyValue key="OptMalus4" + enabled + malus -99 to 2501
OPT_MALUS5 Legacy/KeyValue key="OptMalus5" + enabled + malus -99 to 2501
OPT_MALUS6 Legacy/KeyValue key="OptMalus6" + enabled + malus -99 to 2501
OPT_MALUS7 Legacy/KeyValue key="OptMalus7" + enabled + malus -99 to 2501
OPT_MALUS8 Legacy/KeyValue key="OptMalus8" + enabled + malus -99 to 2501
OPT_MALUS9 Legacy/KeyValue key="OptMalus9" + enabled + malus -99 to 2501
OPT_MALUS10 Legacy/KeyValue key="OptMalus10" + enabled + malus -99 to 2501
OPT_MALUS11 Legacy/KeyValue key="OptMalus11" + enabled + malus -99 to 2501
OPT_MALUS12 Legacy/KeyValue key="OptMalus12" + enabled + malus -99 to 2501
OPT_MALUS13 Legacy/KeyValue key="OptMalus13" + enabled + malus -99 to 2501
OPT_MALUS14 Legacy/KeyValue key="OptMalus14" + enabled + malus -99 to 2501
OPT_MALUS15 Legacy/KeyValue key="OptMalus15" + enabled + malus -99 to 2501
OPT_MALUS16 Legacy/KeyValue key="OptMalus16" + enabled + malus -99 to 2501
OPT_MALUS17 Legacy/KeyValue key="OptMalus17" + enabled + malus -99 to 2501
OPT_MALUS18 Legacy/KeyValue key="OptMalus18" + enabled + malus -99 to 2501
OPT_MALUS19 Legacy/KeyValue key="OptMalus19" + enabled + malus -99 to 2501
OPT_MALUS20 Legacy/KeyValue key="OptMalus20" + enabled + malus -99 to 2501

Segment attributes with a vehicle property

The following segment attributes have a parameter which represents a numerical vehicle property value (e.g. weight, height, length), i.e. if present in ROADEDITOR_ADDITIONAL_OPTIONS all segments carrying the attribute in question will be blocked if the property value exceeds the threshold contained in the data. For example, the data contains all tunnel segments and the threshold value is the maximum height of the tunnel. If the vehicle height is stated in the request, all tunnels which cannot be traveled by this vehicle will be blocked.

Please note that the data usually do not contain both representations, the non-directional (e.g. MAX_WEIGHT) and the directional (e.g. MAX_WEIGHT_DIR), of a parameter. Please consult the data producer for more information.

All of these parameters have a default meaning. If the actual vehicle property is greater than the maximum value (allowed range), the parameter must be the maximum value.

These parameters correspond to the profile element Legacy within AdditionalDataRules:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <Profile>
                <Routing majorVersion="2" minorVersion="0">
                    <Course>
                        <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                            <Legacy>
                                <KeyValue key="MaxHeight" enabled="true" threshold="600"/>
                                <KeyValue key="MaxWeight" enabled="true" threshold="3000"/>
                                <KeyValue key="MaxWidth" enabled="true" threshold="300"/>
                                <KeyValue key="MaxLength" enabled="true" threshold="1000"/>
                                <KeyValue key="MaxAxleLoad" enabled="true" threshold="300"/>
                                <KeyValue key="MaxHeightDir" enabled="true" threshold="60"/>
                                <KeyValue key="MaxWeightDir" enabled="true" threshold="30"/>
                                <KeyValue key="MaxWidthDir" enabled="true" threshold="30"/>
                                <KeyValue key="MaxLengthDir" enabled="true" threshold="100"/>
                                <KeyValue key="MaxAxleLoadDir" enabled="true" threshold="30"/>
                            </Legacy>
                        </AdditionalDataRules>
                    </Course>
                </Routing>
            </Profile>
        
Parameter name Profile element Profile attribute(s) Description Range Unit
MAX_HEIGHT Legacy/KeyValue key="MaxHeight" + enabled + threshold the vehicle height 0 - 655,35 m 1 cm
MAX_WEIGHT Legacy/KeyValue key="MaxWeight" + enabled + threshold the vehicle's total permitted weight 0 - 655,35 t 1 kg / 10 kg see *
MAX_WIDTH Legacy/KeyValue key="MaxWidth" + enabled + threshold the vehicle width 0 - 655,35 m 1 cm
MAX_LENGTH Legacy/KeyValue key="MaxLength" + enabled + threshold the vehicle length 0 - 655,35 m 1 cm
MAX_AXLE_LOAD Legacy/KeyValue key="MaxAxleLoad" + enabled + threshold the vehicle axle load 0 - 655,35 t 10 kg
MAX_HEIGHT_DIR Legacy/KeyValue key="MaxHeightDir" + enabled + threshold the vehicle height 0 - 25,5 m 10 cm
MAX_WEIGHT_DIR Legacy/KeyValue key="MaxWeightDir" + enabled + threshold the vehicle's total permitted weight 0 - 25,5 t 100 kg
MAX_WIDTH_DIR Legacy/KeyValue key="MaxWidthDir" + enabled + threshold the vehicle width 0 - 25,5 m 10 cm
MAX_LENGTH_DIR Legacy/KeyValue key="MaxLengthDir" + enabled + threshold the vehicle length 0 - 25,5 m 10 cm
MAX_AXLE_LOAD_DIR Legacy/KeyValue key="MaxAxleLoadDir" + enabled + threshold the vehicle axle load 0 - 25,4 t 100 kg
* 1kg / 10kg: If the parameter is specified with ROADEDITOR_ADDITIONAL_OPTIONS MAX_WEIGHT please use the unit 1kg. If it is specified with Legacy/KeyValue key="MaxWeight" please use the unit 10kg.

Segment attributes with both parameters, a malus and a vehicle property

The following segment attributes have both a parameter which represents a malus (range -99 to 2501) and a numerical vehicle property value (range 0 to 255), i.e. if present in ROADEDITOR_ADDITIONAL_OPTIONS all segments carrying the attribute in question and their values exceeding the threshold will take the given malus. This is useful to avoid or prefer road segments with vehicles having a certain property (e.g. long or heavy trucks). Please note that the first parameter represents the malus and the second parameter represents the vehicle property value (MALUS;VALUE). The latter must be greater than 0 or can be omitted, the vehicle's length (or weight) will then be used. Please note that an error is thrown if omitted and neither MAX_LENGTH (MAX_WEIGHT) nor MAX_LENGTH_DIR (MAX_WEIGHT_DIR) is given.

Please note that the range of the vehicle property value is 0 to 255 (integer values). The meaning of the value is defined by the data producer.

These parameters correspond to the profile element Legacy within AdditionalDataRules:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <Profile>
                <Routing majorVersion="2" minorVersion="0">
                    <Course>
                        <AdditionalDataRules enabled="true" layerName="TruckAttributes">
                            <Legacy>
                                <KeyValue key="DirOptCondMalus1" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus2" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus3" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus4" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus5" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus6" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus7" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus8" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus9" enabled="true" malus="2501" threshold="100"/>
                                <KeyValue key="DirOptCondMalus10" enabled="true" malus="2501" threshold="100"/>
                            </Legacy>
                        </AdditionalDataRules>
                    </Course>
                </Routing>
            </Profile>
        
Parameter name Profile element Profile attribute(s) Range
DIR_OPT_COND_MALUS1 Legacy/KeyValue key="DirOptCondMalus1" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS2 Legacy/KeyValue key="DirOptCondMalus2" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS3 Legacy/KeyValue key="DirOptCondMalus3" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS4 Legacy/KeyValue key="DirOptCondMalus4" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS5 Legacy/KeyValue key="DirOptCondMalus5" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS6 Legacy/KeyValue key="DirOptCondMalus6" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS7 Legacy/KeyValue key="DirOptCondMalus7" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS8 Legacy/KeyValue key="DirOptCondMalus8" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS9 Legacy/KeyValue key="DirOptCondMalus9" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255
DIR_OPT_COND_MALUS10 Legacy/KeyValue key="DirOptCondMalus10" + enabled + malus + threshold Malus: -99 to 2501; Threshold: 0 to 255

Special use case: truck attributes

Truck attributes are provided by PTV for most maps and they comprise the following subset of the segment attributes.

Truck attributes with a default meaning

namerecommended malusdescription
BLOCKS_TRUCKsee Segment attributes with a boolean parameter, overrides a flag within the map data
MAX_HEIGHTsee Segment attributes with a vehicle property
MAX_WEIGHT
MAX_WIDTH
MAX_LENGTH
MAX_AXLE_LOAD
HAZARDOUS_TO_WATERSsee Segment attributes with a boolean parameter
HAZARDOUS_GOODS
COMBUSTIBLES
TRAILER2500see Segment attributes with a malus parameter
RESIDENTIAL_TRUCKS2500
DELIVERY_TRUCKS2500
PUBLIC_TRUCKS2500
PREFERRED_TRUCKS-99
PREFERRED_HAZARDOUS_TRUCKS-99

Truck attributes without a default meaning

namerecommended malusdescription
DIR_OPT_COND_MALUS12501closed for vehicles with a trailer heavier than a given weight
DIR_OPT_COND_MALUS22501closed for vehicles carrying hazardous material heavier than a given weight
DIR_OPT_COND_MALUS32501closed for vehicles carrying explosive material heavier than a given weight
DIR_OPT_COND_MALUS42501closed for vehicles carrying material hazardous to waters heavier than a given weight
DIR_OPT_COND_MALUS52500closed for vehicles heavier than a given weight except for residential vehicles
DIR_OPT_COND_MALUS62500closed for vehicles heavier than a given weight except for delivery vehicles
DIR_OPT_COND_MALUS72500closed for vehicles heavier than a given weight except for garbage trucks and/or maintenance vehicles
DIR_OPT_COND_MALUS8-99preferred route for vehicles heavier than a given weight
DIR_OPT_COND_MALUS9-99preferred route for vehicles carrying hazardous material heavier than a given weight