@magiclane/maps-sdk
    Preparing search index...

    Class MotorVehicleProfile

    Motor vehicle profile.

    Base class for motorized vehicle profiles such as CarProfile and TruckProfile. Provides common routing parameters used by the routing engine (mass, maximum speed and fuel type).

    Hierarchy (View Summary)

    Index

    Constructors

    • Creates a motor vehicle profile with sensible defaults.

      Parameters

      • Optionaloptions: { fuel?: FuelType; mass?: number; maxSpeed?: number; plateNumber?: string }

        Configuration options

        • Optionalfuel?: FuelType

          Engine fuel type (default FuelType.petrol).

        • Optionalmass?: number

          Vehicle mass in kilograms (default 0).

        • OptionalmaxSpeed?: number

          Maximum vehicle speed in m/s (default 0).

        • OptionalplateNumber?: string

          Registration plate number (default empty).

      Returns MotorVehicleProfile

    Properties

    fuel: FuelType

    Engine fuel type. Default is FuelType.petrol.

    mass: number

    Vehicle mass in kg. By default it is 0 and is not considered in routing.

    maxSpeed: number

    Vehicle maximum speed in m/s. By default it is 0 and is not considered in routing.

    plateNumber: string = ''

    The vehicle's registration plate number.

    Methods

    • Get hash code for use in maps/sets

      Returns number

    • Parameters

      • str: string

      Returns number

    • Returns any