Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VehicleType

The types of vehicle supported.

Hierarchy

  • VehicleType

Index

Constructors

constructor

  • Initializes a VehicleType object.

    Parameters

    • value: string

    Returns VehicleType

Properties

value

value: string

Static All

All: VehicleType = new VehicleType('All')

Combination of all vehicle types - used to find route that allows any VehicleTypes

Static Auto

Auto: VehicleType = new VehicleType('Auto')

Automobile

Static Bus

Bus: VehicleType = new VehicleType('Bus')

Bus

Static CarPool

CarPool: VehicleType = new VehicleType('CarPool')

CarPool vehicle (allows CarPool lane access)

Static Default

Default: VehicleType = new VehicleType('Default')

No specific vehicle type has been set. When applied to a Route, a VehicleType of Auto will be used.

Static Emergency

Emergency: VehicleType = new VehicleType('Emergency')

Emergency Vehicles, such as ambulances, fire, etc.

Static IntermediateDouble

IntermediateDouble: VehicleType = new VehicleType('IntermediateDouble')

A tractor with two intermediate length trailers

Static LongDouble

LongDouble: VehicleType = new VehicleType('LongDouble')

A tractor with two long trailers

Static OtherLCV

OtherLCV: VehicleType = new VehicleType('OtherLCV')

Any other light commercial vehicle (utility van, etc)

Static Pedestrian

Pedestrian: VehicleType = new VehicleType('Pedestrian')

Pedestrian - not fully implemented

Static StandardDouble

StandardDouble: VehicleType = new VehicleType('StandardDouble')

A tractor with two trailers

Static StraightTruck

StraightTruck: VehicleType = new VehicleType('StraightTruck')

Straight truck (as opposed to a tractor/trailer combination)

Static Taxi

Taxi: VehicleType = new VehicleType('Taxi')

Taxi

Static TractorSemiTrailer

TractorSemiTrailer: VehicleType = new VehicleType('TractorSemiTrailer')

A tractor with a single trailer

Static Triple

Triple: VehicleType = new VehicleType('Triple')

A tractor with three trailers

Static Truck

Truck: VehicleType = new VehicleType('Truck')

Combination of different truck types - used to find route that allows all truck VehicleTypes

Static Unknown

Unknown: VehicleType = new VehicleType('Unknown')

No information is known about this vehicle.

Methods

getNumericValue

  • getNumericValue(): any
  • Returns the numerical value of the vehicle type.

    Returns any

toString

  • toString(): string
  • Returns the vehicle type as a human-readable string.

    Returns string

Object literals

Static acceptedValues

acceptedValues: object

The accepted string values for the supported vehicle types.

All

All: string = "All"

Combination of all vehicle types - used to find route that allows any VehicleTypes

Auto

Auto: string = "Auto"

Automobile

Bus

Bus: string = "Bus"

Bus

CarPool

CarPool: string = "CarPool"

A car-pooling vehicle (allows CarPool lane access)

Default

Default: string = "Default"

No specific vehicle type has been set. When applied to a Route, a VehicleType of Auto will be used.

Emergency

Emergency: string = "Emergency"

Emergency vehicle

IntermediateDouble

IntermediateDouble: string = "IntermediateDouble"

An truck with two intermediate-length trailers

LongDouble

LongDouble: string = "LongDouble"

A truck with two long trailers

OtherLCV

OtherLCV: string = "OtherLCV"

Other light commercial vehicle (utility van, etc)

Pedestrian

Pedestrian: string = "Pedestrian"

Someone walking

StandardDouble

StandardDouble: string = "StandardDouble"

A truck with two trailers

StraightTruck

StraightTruck: string = "StraightTruck"

Straight truck (as opposed to a tractor/trailer combination)

Taxi

Taxi: string = "Taxi"

Taxi

TractorSemiTrailer

TractorSemiTrailer: string = "TractorSemiTrailer"

A tractor with a single trailer

Triple

Triple: string = "Triple"

A truck with three trailers

Truck

Truck: string = "Truck"

Combination of the different truck types - used to find route that allows all truck VehicleTypes

Unknown

Unknown: string = "Unknown"

No information about this vehicle is available

Static numericalValues

numericalValues: object

The numerical values for the supported vehicle types.

All

All: number = 0

Auto

Auto: number = 1

Bus

Bus: number = 2

CarPool

CarPool: number = 8

Default

Default: number = 0

Emergency

Emergency: number = 256

IntermediateDouble

IntermediateDouble: number = 4096

LongDouble

LongDouble: number = 8192

OtherLCV

OtherLCV: number = 32768

Pedestrian

Pedestrian: number = 16

StandardDouble

StandardDouble: number = 2048

StraightTruck

StraightTruck: number = 512

Taxi

Taxi: number = 4

TractorSemiTrailer

TractorSemiTrailer: number = 1024

Triple

Triple: number = 16384

Truck

Truck: number = 0

Unknown

Unknown: number = 65536

Generated using TypeDoc