Class VehicleSpecification
Class VehicleSpecification
- java.lang.Object
-
- com.here.sdk.transport.VehicleSpecification
-
public final class VehicleSpecification extends java.lang.ObjectContains vehicle related attributes. Examples: Dimensions, weight, axle count. Only the fields that are set are considered for restriction handling. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVehicleSpecification.BusBuilderThis class constructs aVehicleSpecificationfor a bus.static classVehicleSpecification.CarBuilderThis class constructs aVehicleSpecificationfor a car.static classVehicleSpecification.PrivateBusBuilderThis class constructs aVehicleSpecificationfor a private bus.static classVehicleSpecification.ScooterBuilderThis class constructs aVehicleSpecificationfor a scooter.static classVehicleSpecification.TaxiBuilderThis class constructs aVehicleSpecificationfor a taxi.static classVehicleSpecification.TruckBuilderThis class constructs aVehicleSpecificationfor a truck.
-
Field Summary
Fields Modifier and Type Field Description java.lang.IntegeraxleCountDefines total number of axles in the vehicle.java.lang.IntegercurrentWeightInKilogramsCurrent truck weight, including trailers and shipped goods currently loaded, specified in kilograms.java.lang.IntegerengineSizeInCubicCentimetersEngine size of the scooter in cubic centimeters.java.lang.IntegergrossWeightInKilogramsGross truck weight, including trailers and shipped goods when loaded at capacity, specified in kilograms.java.util.List<HazardousMaterial>hazardousMaterialsSpecifies a list of hazardous materials shipped in the vehicle.java.lang.IntegerheightInCentimetersVehicle height in centimeters.booleanisCommercialSpecifies whether the vehicle is a commercial or a non-commercial vehicle.booleanisTruckLightA flag indicating whether the truck is light enough to be classified more as a car than a truck in Japan.java.lang.StringlastCharacterOfLicensePlateLast character of license plate in String format.java.lang.IntegerlengthInCentimetersVehicle length in centimeters.java.lang.IntegeroccupancySpecifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes.java.lang.IntegerpayloadCapacityInKilogramsAllowed payload capacity, including trailers, specified in kilograms.java.lang.IntegertiresCountThe total number of tires the vehicle has, i.e., the tires on the base vehicle and any attached trailers.java.lang.IntegertrailerAxleCountDefines total number of axles across all the trailers attached to the vehicle.java.lang.IntegertrailerCountDefines number of trailers attached to the vehicle.TruckCategorytruckCategoryDefines the truck category.TruckTypetruckTypeWill be replaced withtruckCategorywhen theTruckSpecificationwill be replaced byVehicleSpecification.TunnelCategorytunnelCategorySpecifies the tunnel categories to restrict certain route links.WeightPerAxleGroupweightPerAxleGroupAllows specification of axle weights in a more fine-grained way thanweightPerAxleInKilograms.java.lang.IntegerweightPerAxleInKilogramsHeaviest weight per axle, regardless of axle type or axle group.java.lang.IntegerwidthInCentimetersVehicle width in centimeters.
-
Constructor Summary
Constructors Constructor Description VehicleSpecification()Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)inthashCode()
-
-
-
Field Detail
-
heightInCentimeters
@Nullable public java.lang.Integer heightInCentimeters
Vehicle height in centimeters. The provided value must be in the range [0, 5000]. By default, it is not set.
Note: Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
widthInCentimeters
@Nullable public java.lang.Integer widthInCentimeters
Vehicle width in centimeters. The provided value must be in the range [0, 5000]. By default, it is not set.
Note: Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
lengthInCentimeters
@Nullable public java.lang.Integer lengthInCentimeters
Vehicle length in centimeters. The provided value must be in the range [0, 30000]. By default, it is not set.
Note: Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
axleCount
@Nullable public java.lang.Integer axleCount
Defines total number of axles in the vehicle. The provided value must be greater than or equal to 2. By default, it is not set. Route calculation: When not set, possible axle count restrictions will not be taken into consideration. Rendering: When set, truck restriction icons for an axle count greater than
axleCountwill not be displayed. When specifyingtrailerAxleCount, thenaxleCountis required and must be greater thantrailerAxleCount.Note: Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
trailerCount
@Nullable public java.lang.Integer trailerCount
Defines number of trailers attached to the vehicle. The provided value must be in the range [0, 255]. By default, it is not set. When specifying
trailerAxleCount, thentrailerCountis required and must be greater than 0.
-
truckType
@NonNull public TruckType truckType
Will be replaced with
truckCategorywhen theTruckSpecificationwill be replaced byVehicleSpecification. Defines the type of truck. Defaults toTruckType.STRAIGHT. Renderingsdk.mapview.TruckProfile:truckTypeis ignored and has no effect.
-
truckCategory
@Nullable public TruckCategory truckCategory
Defines the truck category. By default, it is not set. Rendering:
truckCategoryis ignored and has no effect.
-
isTruckLight
public boolean isTruckLight
A flag indicating whether the truck is light enough to be classified more as a car than a truck in Japan. The flag should not be set to
truein other countries than Japan. Defaults tofalse.A light truck exempts from many legal restrictions for normal trucks in Japan, for example, which streets the vehicle can access, which access restrictions apply, and which speed limits are applicable. Restrictions related to the dimensions of the truck, or its cargo may still apply and setting this flag will not always overwrite these settings. Make sure to not exceed the specifications that classify a truck as light.
In Japan, for light trucks the same restrictions apply as for cars. Therefore, when the flag is set to
true, you will get, for example, the same speed limits as for cars. Make sure to set the flag only totrue, when a vehicle matches the classification for light trucks according to the vehicle regulations in Japan.When on
MapContentSettings, then this flag will be ignored and has no effect.Notes:
- This flag and the concept of light trucks are supported only in Japan as beta and are considered to be experimental in other regions. Therefore, for now, it is recommended to use this flag only in Japan. Note that this is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
- Supported only in
TransportMode.TRUCKtransport mode.
-
payloadCapacityInKilograms
@Nullable public java.lang.Integer payloadCapacityInKilograms
Allowed payload capacity, including trailers, specified in kilograms. The provided value must be greater then or equal to 0. By default, it is not set.
Note: Supported in
TransportMode.TRUCK,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
trailerAxleCount
@Nullable public java.lang.Integer trailerAxleCount
Defines total number of axles across all the trailers attached to the vehicle. This number is included in
axleCount, hencetrailerAxleCountmust be less thanaxleCountand greater than or equal to 1.axleCountandtrailerCountare required to specifytrailerAxleCount. By default, it is not set.Note:: This parameter is currently used only for the calculation of tolls in regions where it is applicable.
-
grossWeightInKilograms
@Nullable public java.lang.Integer grossWeightInKilograms
Gross truck weight, including trailers and shipped goods when loaded at capacity, specified in kilograms. The provided value must be greater than or equal to 0. If unspecified, it will default to
currentWeightInKilograms. By default, it is not set.Notes:
- Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes. - Maximum weight for a car or taxi without a trailer is 4250 kg.
- Maximum weight for a car or taxi with a trailer is 7550 kg.
- Supported in
-
currentWeightInKilograms
@Nullable public java.lang.Integer currentWeightInKilograms
Current truck weight, including trailers and shipped goods currently loaded, specified in kilograms. The provided value must be greater than or equal to 0. If unspecified, it will default to
grossWeightInKilograms. By default, it is not set.Notes:
- Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes. - Maximum weight for a car or taxi without a trailer is 5000 kg.
- Maximum weight for a car or taxi with a trailer is 8500 kg.
- A route request with
currentWeightInKilogramsabovegrossWeightInKilogramsmay result in non-compliant or invalid routes.
- Supported in
-
weightPerAxleInKilograms
@Nullable public java.lang.Integer weightPerAxleInKilograms
Heaviest weight per axle, regardless of axle type or axle group. It is evaluated against all axle weight restrictions, including single axle and tandem axle weight restrictions. The provided value must be greater or equal to 0. By default, it is not set.
Notes:
weightPerAxleInKilogramsandweightPerAxleGroupare incompatible. When available for your edition, if both attributes are set, during onlineRoutingEngineanRoutingError.INVALID_PARAMETERerror is generated. Otherwise, when offlineRoutingEngineis in place, both parameters are evaluated and the maximum value between them will be used.- Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
weightPerAxleGroup
@Nullable public WeightPerAxleGroup weightPerAxleGroup
Allows specification of axle weights in a more fine-grained way than
weightPerAxleInKilograms. This is relevant in countries with signs and regulations that specify different limits for different axle groups, like the USA and Sweden. By default is not set.Notes:
weightPerAxleInKilogramsandweightPerAxleGroupare incompatible. When available for your edition, if both attributes are set, during onlineRoutingEngineanRoutingError.INVALID_PARAMETERerror is generated. Otherwise, when offlineRoutingEngineis in place, both parameters are evaluated and the maximum value between them will be used.- Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
isCommercial
public boolean isCommercial
Specifies whether the vehicle is a commercial or a non-commercial vehicle. Defaults to
false.Notes
- Only supported for online routing.
- This parameter is currently used only for the calculation of tolls in regions where it is applicable.
- Not used for offline calculations.
- Supported for
TransportMode.CAR,TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUSandTransportMode.TAXI.
-
lastCharacterOfLicensePlate
@Nullable public java.lang.String lastCharacterOfLicensePlate
Last character of license plate in String format. This value can be used to evaluate restrictions in environmental zones. By default, it is not set.
-
engineSizeInCubicCentimeters
@Nullable public java.lang.Integer engineSizeInCubicCentimeters
Engine size of the scooter in cubic centimeters. Shouldn't be less than 1 or greater than 65535. Default value is
null, which means the scooter route calculation ignores all engine size limits on the road.Notes
- For now, this option is only relevant in Japan and will be ignored for other countries. Currently, map data for this option is only available for Japan.
- Supported only in
TransportMode.SCOOTER(Alpha) transport mode.
-
tiresCount
@Nullable public java.lang.Integer tiresCount
The total number of tires the vehicle has, i.e., the tires on the base vehicle and any attached trailers. By default, it is not set. Otherwise it is guaranteed to be in the range [1, 255].
Note: This parameter is not supported in isoline routing.
-
tunnelCategory
@Nullable public TunnelCategory tunnelCategory
Specifies the tunnel categories to restrict certain route links. The route will pass only through tunnels of a less strict category. Refer to
TunnelCategoryfor the available options. By default, it is not set.Note: Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
hazardousMaterials
@NonNull public java.util.List<HazardousMaterial> hazardousMaterials
Specifies a list of hazardous materials shipped in the vehicle. Refer to
HazardousMaterialfor the available options. By default, it is an empty list.Note: Supported in
TransportMode.TRUCK,TransportMode.BUS,TransportMode.PRIVATE_BUS,TransportMode.CAR(Beta),TransportMode.TAXI(Beta) transport modes.
-
occupancy
@Nullable public java.lang.Integer occupancy
Specifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes. Should not be less than 1 or greater than 255. By default, it is not set.
-
-