VehicleDimensions

public struct VehicleDimensions

Describes dimensions of the vehicle.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Creates vehicle dimensions.

    Note

    Parameters weight, axleWeight, length, width, and height are not yet supported with the Orbis map.

    Throws

    VehicleError.invalidVehicleSnapshot if vehicle dimensions negative.

    Declaration

    Swift

    public init
    (
        weight: Measurement<UnitMass>? = nil,
        axleWeight: Measurement<UnitMass>? = nil,
        length: Measurement<UnitLength>? = nil,
        width: Measurement<UnitLength>? = nil,
        height: Measurement<UnitLength>? = nil,
        numberOfAxles: Int? = nil
    ) throws

    Parameters

    weight

    Specifies the weight of the vehicle, typically in kilograms.
    axleWeight

    Specifies the weight per axle of the vehicle, typically in kilograms.
    length

    Specifies the length of the vehicle including the length of any additional equipment, e.g., trailers, bike racks, etc.
    width

    Specifies the width of the vehicle.
    height

    Specifies the height of the vehicle.
    numberOfAxles

    Specifies the number of vehicle axles.

Public

  • Specifies the weight of the vehicle, typically in kilograms.

    Note

    This option is not yet supported with the Orbis map.

    Declaration

    Swift

    public let weight: Measurement<UnitMass>?

  • Specifies the weight per axle of the vehicle, typically in kg.

    Note

    This option is not yet supported with the Orbis map.

    Declaration

    Swift

    public let axleWeight: Measurement<UnitMass>?

  • Specifies the length of the vehicle.

    Note

    This option is not yet supported with the Orbis map.

    Declaration

    Swift

    public let length: Measurement<UnitLength>?

  • Specifies the width of the vehicle.

    Note

    This option is not yet supported with the Orbis map.

    Declaration

    Swift

    public let width: Measurement<UnitLength>?

  • Specifies the height of the vehicle.

    Note

    This option is not yet supported with the Orbis map.

    Declaration

    Swift

    public let height: Measurement<UnitLength>?

  • Specifies the number of vehicle axles.

    Note

    This option is not yet supported with the Orbis map.

    Declaration

    Swift

    public let numberOfAxles: Int?