The vehicleprofile namespace defines the VehicleProfile type which is part of the main profile.
Types
Defines the number of axles of the vehicle and the axle load.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| axleLoad | Kilograms (Double) | no | 11500.0 | 2.0 | The axle load. (2,4) Categories: highPerformanceRouting |
| numberOfAxles | NonNegativeInteger (Integer) | no | 5 | 2.0 | The number of axles the vehicle has. (2) |
| numberOfTires | NonNegativeInteger (Integer) | no | 10 | 2.27 | The number of tires the vehicle has. (2,3) Usually twice the number of axles, but it can be used to model vehicles such as motorbikes, tricycles or vehicles with twin wheels. |
Defines the size parameters of the vehicle, e.g. height, length, etc.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| height | Dimension (Double) | no | 400.0 | 2.0 | The vehicle's height. (2,4) Categories: highPerformanceRouting |
| heightAboveFrontAxle | Dimension (Double) | no | 400.0 | 2.0 | The vehicle's height above the front axle. (2) |
| length | Dimension (Double) | no | 1650.0 | 2.0 | The vehicle's length. (2,4) Categories: highPerformanceRouting |
| width | Dimension (Double) | no | 254.0 | 2.0 | The vehicle's width. (2,4) Categories: highPerformanceRouting |
| kingpinToRearAxle | Dimension (Double) | no | 0.0 | 2.32 | The distance from the kingpin to the rear axle of a semi-trailer truck. (2,4) Categories: highPerformanceRouting |
Defines the engine parameters of the vehicle. These parameters are only relevant if the driveType is MOTOR_VEHICLE. Several parameters depend on each other so that inconsistent and ignored parameters will be reported in ResultLimitations. See the technical concept for details.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| engineType | EngineType | no | EngineType.COMBUS ... | 2.16 | The engine type. Depending on the engine type only a subset of the other engine parameters is relevant. When changing the engine type further parameters must be specified to define a valid vehicle and to obtain proper results. For a hybrid or an electric vehicle electricityType and electricityConsumption must be specified, for a hybrid vehicle additionally the hybridRatio. (1,2,3) |
| cylinderCapacity | CylinderCapacity (Integer) | no | 12000 | 2.0 | The cylinder capacity. Only relevant for COMBUSTION and HYBRID vehicles. (2,3) |
| fuelType | FuelType | no | FuelType.DIESEL | 2.0 | The type of fuel (gasoline, diesel, etc.). The fuel types CNG_GASOLINE and LNG_GASOLINE are used for dual-fuel vehicles, therefore the dualFuelRatio has to be specified. These fuel types cannot be used with hybrid vehicles. Only relevant for COMBUSTION and HYBRID vehicles. (3) |
| electricityType | ElectricityType | no | ElectricityType.NONE | 2.27 | The electricity type. Only relevant for ELECTRIC and HYBRID vehicles. (3) |
| bioFuelRatio | Percent (Double) | no | 0.0 | 2.0 | The ratio of biofuel to conventional fuel, only supported for the fuel types GASOLINE, DIESEL, CNG_GASOLINE and LNG_GASOLINE. (3) |
| hybridRatio | Percent (Double) | no | 0.0 | 2.27 | The ratio between ELECTRIC and COMBUSTION source for HYBRID vehicles. (3) |
| dualFuelRatio | Percent (Double) | no | 0.0 | 2.27 | The ratio between LPG/CNG and GASOLINE fuels for dual-fuel vehicles. (3) |
| fuelConsumption | EnergyConsumption (Double) | no | 35.0 | 2.0 | The fuel consumption for engine type COMBUSTION and HYBRID [l/100km or kg/100km]. See the technical concept for details on the units, in particlar for dual-fuel engines. (1,3) |
| electricityConsumption | EnergyConsumption (Double) | no | 0.0 | 2.27 | The electricity consumption for engine type ELECTRIC and HYBRID [kWh/100km]. (1,3) |
| consumptionFactorsPerSpeed | ConsumptionFactorAtSpeed[] | 0..* | - | 2.27 | The consumption factors relative to Engine.fuelConsumption and Engine.electricityConsumption of the engine at different speeds (1). It is used for monetary cost optimized routing to assign energy costs to road segments in the following way:
|
| emissionTechnology | EmissionTechnology | no | EmissionTechnolog ... | 2.0 | The emission technology (only relevant for some emission classes). Only relevant for COMBUSTION and HYBRID vehicles. (3) |
| particleFilterInstalled | Boolean | no | false | 2.0 | Describes if a particle filter is installed. Only relevant for COMBUSTION and HYBRID vehicles. (2) |
| particleReductionClass | ParticleReductionClass | no | ParticleReduction ... | 2.0 | The particle reduction class (Partikelminderungsklasse) according to "Anlage XIV zu § 48 StVZO" (German law). Only relevant for COMBUSTION and HYBRID vehicles. (2) |
| emissionStandardEU | EmissionStandardEU | no | EmissionStandardE ... | 2.0 | The emission standard valid in the European Union. Only relevant for COMBUSTION and HYBRID vehicles. (2,3) |
| emissionStandardAustralia | EmissionStandardAustralia | no | EmissionStandardA ... | 2.0 | The emission standard valid in Australia. Only relevant for COMBUSTION and HYBRID vehicles. (2,3) |
| lowEmissionZoneTypes | CommaSeparatedList (String) | no | - | 2.0 | Describes the low emission zone sticker types on the windscreen of the vehicle as a comma-separated list (only if the Feature Layer PTV_LowEmissionZones is enabled). The available sticker types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_LowEmissionZones', profile property 'unauthorizedType'). Use the value NONE, if you have none of the available stickers on the vehicle's windscreen (means a blank windscreen). The treatment of road segments that are not allowed because of the low emission zone type is controlled by the penalty value forbiddenLowEmissionZonePenalty. (1) Categories: highPerformanceRouting |
| lowEmissionZoneExemptions | CommaSeparatedList (String) | no | NONE | (2.30) | The low-emission zone exemptions of the vehicle as a comma-separated list (only if the Feature Layer PTV_LowEmissionZones is enabled). The exemptions allow to enter a zone even if the criteria of the vehicle does not allow it. The available zones can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_LowEmissionZones', profile property 'zoneId'). Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (1) Categories: highPerformanceRouting This field is experimental. Before using it, make sure you understand the implications of Experimental features. |
| co2EmissionClassEU | Co2EmissionClassEU (Integer) | no | 1 | 2.31 | The CO₂ emission class valid in the European Union. See also the Directive 1999/62/EC of the European Parliament and of the Council on the charging of heavy goods vehicles for the use of certain infrastructures, Article 7ga. Note that CO₂ emission class 5 requires engine type electric and vice versa, and emission classes 2-4 require an emission standard of EURO_6 or better. (2) |
Defines a legal condition of the vehicle, e.g. whether the vehicle is delivering goods or is an emergency vehicle.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| isEmergency | Boolean | no | false | 2.0 | True for emergency vehicles. If this condition is set to true, certain parts of the road network that are prohibited except that emergency vehicles are accessible for the routing algorithm, and these parts are then treated exactly the same way as normal parts of the road network that are not prohibited. This setting affects segments which have set RoadAttributes.allowedForEmergency. (1) Categories: highPerformanceRouting |
| isDelivery | Boolean | no | true | 2.0 | True for vehicles which are intended to deliver something. If this condition is set to true, certain parts of the road network that are prohibited except for delivery vehicles are accessible for the routing algorithm. The treatment of such parts can be configured in the routing profile using the parameters SpecialAreas.deliveryOnlyPenalty and SpecialAreas.deliveryOnlyGateCost. These settings affect segments which have set RoadAttributes.deliveryOnly. (1,4) Categories: highPerformanceRouting |
Defines the current load of the vehicle
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| hazardousGoodsTypes | CommaSeparatedList (String) | no | NONE | 2.0 | Specifies the hazardous goods types of the load as a comma-separated list (only if the Feature Layer PTV_TruckAttributes is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_TruckAttributes', profile properties 'combustibles', 'hazardousGoods' and 'hazardousToWaters') and are documented in the manual as layer-specific properties of the Feature Layer PTV_TruckAttributes. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (4) Categories: highPerformanceRouting |
| loadType | LoadType | no | LoadType.GOODS | 2.0 | The load type of the vehicle, e.g. passengers or goods, etc. This parameter is important to derive the type of the vehicle. For example, if the vehicle's weight is about 10 tons, then the load type can help to determine whether the vehicle is a truck or a bus. (1,2,3,4) Categories: highPerformanceRouting |
| tunnelRestrictionCode | TunnelRestrictionCode | no | TunnelRestriction ... | 2.0 | The tunnel restriction code for dangerous load. (4) Categories: highPerformanceRouting |
Defines the speed intervals for each network class. The road segments of a network class are classified into subtypes which are automatically assigned a speed value from the interval. If speed information from a Feature Layer such as PTV_SpeedPatterns or PTV_TrafficIncidents is available for a segment it overrides the speed defined here. (1)
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| maximumSpeeds | Speed[] (Double[]) | 8..8 | - | 2.0 | The maximum speeds for each network class. Default: 80,65,55,45,40,30,30,30. Categories: highPerformanceRouting |
| minimumSpeeds | Speed[] (Double[]) | 8..8 | - | 2.0 | The minimum speeds for each network class. Default: 55,30,23,20,18,15,15,15. Categories: highPerformanceRouting |
Defines the speed values used by the routing algorithm to calculate the travel time of a road segment. All speed values given here are internally rounded to km/h.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| speedRangesByNetworkClass | SpeedRangesByNetworkClass | no | - | 2.0 | Defines the speed intervals for each network class. The road segments of a network class are classified into subtypes which are automatically assigned a speed value from the interval. If speed information from a Feature Layer such as PTV_SpeedPatterns or PTV_TrafficIncidents is available for a segment it overrides the speed defined here. (1) |
| speedForLinkDistance | Speed (Double) | no | 15.0 | 2.0 | The notional speed for the distance from a waypoint to its link point on the road network. (1) |
| maximumSpeed | Speed (Double) | no | 255.0 | 2.0 | The absolute maximum speed for all road segments. The speeds calculated from the interval [minimumSpeed, maximumSpeed] for each network class, will be limited to this speed value. Note: an interval [70,135] for network class 0 with a maximum speed of 120 km/h is not equal to the interval [70,120]. A maximum speed of 0 is ignored. (1) Categories: highPerformanceRouting |
Defines the vehicle to be used which activates rules of different algorithms. Please note that all values apply to the complete vehicle including trailers. Note that the results may be incorrect because the legal definition of a vehicle type may differ from country to country and it may also differ from the technical definition. As an example, a truck with a weight of 7.5 tons is a truck by legal definition in Germany but is not a truck by definition of toll. Most parameters are used for several use cases. They are denoted with (1) for routing, (2) for toll, (3) for emission calculation, (4) for truck attributes, and (5) for preferred routes. Give as many details on the vehicle as possible in order to obtain the best result.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| engine | Engine | no | - | 2.0 | Defines the engine parameters of the vehicle. These parameters are only relevant if the driveType is MOTOR_VEHICLE. |
| weight | Weight | no | - | 2.0 | Defines the weight parameters of the vehicle. The actual weight of the vehicle is the sum of the empty weight and the load weight. |
| dimensions | Dimensions | no | - | 2.0 | Defines the size parameters of the vehicle, e.g. height, length, etc. |
| axle | Axle | no | - | 2.0 | Defines the number of axles of the vehicle and the axle load. |
| legalCondition | LegalCondition | no | - | 2.0 | Defines a legal condition of the vehicle, e.g. whether the vehicle is delivering goods or is an emergency vehicle. |
| load | Load | no | - | 2.0 | Defines the current load of the vehicle |
| speeds | Speeds | no | - | 2.0 | Defines the speed values used by the routing algorithm to calculate the travel time of a road segment. All speed values given here are internally rounded to km/h. |
| driveType | DriveType | no | DriveType.MOTOR_V ... | 2.0 | The type of the vehicle, e.g. motorized, pedestrian, etc. (1,2,3,4) Categories: highPerformanceRouting |
| yearOfManufacture | PositiveInteger (Integer) | no | 2015 | 2.0 | The vehicle's construction year. (3) |
| numberOfPassengers | PositiveInteger (Integer) | no | 1 | 2.0 | The actual number of passengers including the driver. (2) |
| numberOfTrailers | NonNegativeInteger (Integer) | no | 0 | 2.0 | The number of trailers. (2,3,4) Categories: highPerformanceRouting |
| preferredRouteTypes | CommaSeparatedList (String) | no | NONE | 2.0 | The road networks to be preferred by the routing algorithm as a comma-separated list (only if the Feature Layer PTV_PreferredRoutes is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_PreferredRoutes', profile property 'preferredRouteType') and are documented in the manual as layer-specific properties of the Feature Layer PTV_PreferredRoutes. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (5) Categories: highPerformanceRouting |
| unrestrictedRouteTypes | CommaSeparatedList (String) | no | NONE | 2.20 | The road networks without restrictions as a comma-separated list (only if the Feature Layer PTV_PreferredRoutes is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_PreferredRoutes', profile property 'unrestrictedRouteType') and are documented in the manual as layer-specific properties of the Feature Layer PTV_PreferredRoutes. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (5) Categories: highPerformanceRouting |
| restrictedRouteTypes | CommaSeparatedList (String) | no | NONE | 2.2 | The road networks that should be avoided as far as possible, e.g. for convenience reasons, as a comma-separated list (only if the Feature Layer PTV_PreferredRoutes is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_PreferredRoutes', profile property 'restrictedRouteType') and are documented in the manual as layer-specific properties of the Feature Layer PTV_PreferredRoutes. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (5) Categories: highPerformanceRouting |
| highlyRestrictedRouteTypes | CommaSeparatedList (String) | no | NONE | 2.2 | The road networks that must be avoided, e.g. due to legal limitations, as a comma-separated list (only if the Feature Layer PTV_PreferredRoutes is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_PreferredRoutes', profile property 'highlyRestrictedRouteType') and are documented in the manual as layer-specific properties of the Feature Layer PTV_PreferredRoutes. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (5) Categories: highPerformanceRouting |
| prohibitedRouteTypes | CommaSeparatedList (String) | no | NONE | 2.0 | The road networks that are prohibited for the vehicle as a comma-separated list (only if the Feature Layer PTV_PreferredRoutes is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service (Feature Layer theme 'PTV_PreferredRoutes', profile property 'prohibitedRouteType') and are documented in the manual as layer-specific properties of the Feature Layer PTV_PreferredRoutes. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (5) Categories: highPerformanceRouting |
| electronicTollCollectionSubscriptions | CommaSeparatedList (String) | no | NONE | 2.16 | The subscriptions for electronic toll collection systems the vehicle can use as a comma-separated list (only if toll is enabled). The available types can be requested through the operation getDataInformation in the xRuntime service and are returned in TollFeatures.electronicTollCollectionSubscriptions for the map and in TollFeatures.electronicTollCollectionSubscriptions for a country or subdivision. Use the special value 'NONE' to override a non-empty list from the stored profile with an empty list. (2) |
Defines the weight parameters of the vehicle. The actual weight of the vehicle is the sum of the empty weight and the load weight. Note that a ParameterInconsistencyLimitation is returned with the response if the actual weight is larger than the total permitted weight or the total permitted weight is larger than the total technically permitted weight. See the technical concept for more details.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| emptyWeight | Kilograms (Double) | no | 15000.0 | 2.0 | The empty weight. (3,4) Categories: highPerformanceRouting |
| loadWeight | Kilograms (Double) | no | 25000.0 | 2.0 | The weight of the vehicle's load. (3,4) Categories: highPerformanceRouting |
| totalPermittedWeight | Kilograms (Double) | no | 40000.0 | 2.0 | The total permitted weight. If it is not specified and Weight.totalTechnicallyPermittedWeight is specified then Weight.totalTechnicallyPermittedWeight will be used. (1,2,3,4) Categories: highPerformanceRouting |
| totalTechnicallyPermittedWeight | Kilograms (Double) | no | 40000.0 | 2.32 | The total technically permitted weight. If it is not specified and Weight.totalPermittedWeight is specified then Weight.totalPermittedWeight will be used. See the technical concept on toll for more details on the relevance of this parameter for toll calculation. (2) |
Defines the emission standard of the vehicle valid in Australia.
Defines the emission standard of the vehicle valid in the European Union.
Defines the engine type of the vehicle.
| Enumeration Value | Since | Description |
|---|---|---|
| COMBUSTION | 2.16 | Combustion. Further distinction by FuelType. |
| ELECTRIC | 2.16 | Electric. Further distinction by ElectricityType. |
| HYBRID | 2.27 | Vehicles with more than one type. |
| NONE | 2.27 | No engine. For non-motorized vehicles, e.g bicycle. |
Defines the fuel type of the vehicle.
Defines the type of load and is mainly used to differentiate between cars and trucks. This setting controls the road blocks in the road network and the calculation of other mostly vehicle-dependent values such as toll and emissions.
Defines the particle reduction class (Partikelminderungsklasse) according to "Anlage XIV zu § 48 StVZO" (German law).
Defines the main tunnel restriction codes according to ADR ("European Agreement Concerning the International Carriage of Dangerous Goods by Road"). There are some more restriction codes that are a combination of the main codes where the actual restriction code depends on other parameters of the vehicle and its load. For example, the restriction code B/D is B for tank carriage and D for other carriage.