Package com.here.sdk.transport

Class VehicleSpecification

java.lang.Object
com.here.sdk.transport.VehicleSpecification
public final class VehicleSpecification extends Object

Contains vehicle related attributes. Examples: Dimensions, weight, axle count. Only the fields that are set are considered for restriction handling.

  • Field Details

    • heightInCentimeters

      @Nullable public 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 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 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 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 axleCount will not be displayed. When specifying trailerAxleCount, then axleCount is required and must be greater than trailerAxleCount.

      Note: Supported in TransportMode.TRUCK, TransportMode.BUS, TransportMode.PRIVATE_BUS, TransportMode.CAR (Beta), TransportMode.TAXI (Beta) transport modes.

    • trailerCount

      @Nullable public 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, then trailerCount is required and must be greater than 0.

    • truckType

      @Deprecated @NonNull public TruckType truckType
      Deprecated.

      Will be removed in v4.27.0. Use VehicleSpecification.truckCategory instead.

      Will be replaced with truckCategory when the TruckSpecification will be replaced by VehicleSpecification. Defines the type of truck. Defaults to TruckType.STRAIGHT. Rendering sdk.mapview.TruckProfile: truckType is ignored and has no effect.

    • truckCategory

      @Nullable public TruckCategory truckCategory

      Defines the truck category. By default, it is not set. Rendering: truckCategory is 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 true in other countries than Japan. Defaults to false.

      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 to true, 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.TRUCK transport mode.

    • payloadCapacityInKilograms

      @Nullable public 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 Integer trailerAxleCount

      Defines total number of axles across all the trailers attached to the vehicle. This number is included in axleCount, hence trailerAxleCount must be less than axleCount and greater than or equal to 1. axleCount and trailerCount are required to specify trailerAxleCount. By default, it is not set.

      Note:: This parameter is currently used only for the calculation of tolls in regions where it is applicable.

    • kingpinToRearAxleDistanceInCentimeters

      @Nullable public Integer kingpinToRearAxleDistanceInCentimeters

      Defines the kingpin to rear axle distance, in centimeters.

      NOTE: Currently, the KPRA restrictions are only present in California and Idaho. Note: Supported in TransportMode.TRUCK, TransportMode.CAR (Beta), TransportMode.TAXI (Beta) transport modes.

    • emptyWeightInKilograms

      @Nullable public Integer emptyWeightInKilograms

      Empty weight of the vehicle without any load, excluding trailers, specified in kilograms. The provided value must be greater than or equal to 0. By default, it is not set.

      Note: Supported in TransportMode.TRUCK, TransportMode.BUS, TransportMode.PRIVATE_BUS, TransportMode.CAR (Beta), TransportMode.TAXI (Beta) transport modes.

    • grossWeightInKilograms

      @Nullable public 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:

    • currentWeightInKilograms

      @Nullable public 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:

    • weightPerAxleInKilograms

      @Nullable public 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:

    • 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:

    • isCommercial

      public boolean isCommercial

      Specifies whether the vehicle is a commercial or a non-commercial vehicle. Defaults to false.

      Notes

    • lastCharacterOfLicensePlate

      @Nullable public 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 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 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 TunnelCategory for 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 List<HazardousMaterial> hazardousMaterials

      Specifies a list of hazardous materials shipped in the vehicle. Refer to HazardousMaterial for 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 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.

  • Constructor Details

    • VehicleSpecification

      public VehicleSpecification()

      Creates a new instance.

  • Method Details