This class allows to configure the vehicles used for routing (allowed streets) and calculation of arrival time.
Vehicle profiles are predefined in the data. They can be read with an iterator VehicleProfile.getVehicleProfileIterator() and individually activated.
More...
Vehicle profiles can have extended attributes (wheight per axle, length, height etc.). Those have to be activated separately (see VehicleProfile.getVehicleAttributesEnabled())
◆ equals()
| boolean equals |
( |
Object |
o | ) |
|
|
inherited |
◆ getActiveProfile()
- Returns
- current set vehicle profile
◆ getProfileName()
| native String getProfileName |
( |
| ) |
|
- Returns
- name of the profile
◆ getVehicleAttributesEnabled()
| boolean getVehicleAttributesEnabled |
( |
| ) |
|
- Returns
- true if the vehicle attributes for the current active vehicle are enabled
◆ getVehicleHeight()
| native double getVehicleHeight |
( |
| ) |
|
◆ getVehicleLength()
| native double getVehicleLength |
( |
| ) |
|
- Returns
- vehicle length in meters
◆ getVehicleLoading()
| native int getVehicleLoading |
( |
| ) |
|
- Returns
- vehicle loading bitmask (additive combination of enum VehicleLoadType)
◆ getVehicleLoadingTRC()
- Returns
- The loading TRC (tunnel restriction code)
◆ getVehicleNumAxles()
| native int getVehicleNumAxles |
( |
| ) |
|
◆ getVehicleNumTrailers()
| native int getVehicleNumTrailers |
( |
| ) |
|
◆ getVehicleProfileIterator()
| static native Iterable< VehicleProfile > getVehicleProfileIterator |
( |
| ) |
|
|
static |
- Returns
- iterator of available Vehicle profiles
◆ getVehicleProfileIteratorByName()
| static native Iterable< VehicleProfile > getVehicleProfileIteratorByName |
( |
String |
name | ) |
|
|
static |
Get iterator set to vehicle profile with the given name.
The following cases can occur: a) A vehicle profile with the exact given name exists b) A vehicle profile with the exact given name does not exist
In case a) the iterator points to that profile, in case b) the iterator is empty.
Note: In case a) the iterator may contain more than one profile (it contains all profiles with name lexicographically >= than the profile name searched for)
- Parameters
-
- Returns
- iterator set to the vehicle profile (case a) or empty iterator if the profile was not found (case b)
◆ getVehicleTotalWeight()
| native double getVehicleTotalWeight |
( |
| ) |
|
- Returns
- vehicle total weight In kilogram
◆ getVehicleType()
- Returns
- type of the profile
◆ getVehicleWeightPerAxle()
| native double getVehicleWeightPerAxle |
( |
| ) |
|
- Returns
- vehicle weight per axle in kilogram
◆ getVehicleWidth()
| native double getVehicleWidth |
( |
| ) |
|
- Returns
- vehicle width in meters
◆ setAsActiveProfile()
Activate current vehicle profile for navigation
- Returns
- Errorcode
◆ setVehicleAttributesEnabled()
| ApiError setVehicleAttributesEnabled |
( |
final boolean |
enabled | ) |
|
- Parameters
-
| enabled | - if true, activate the vehicle specific attributes |
- Returns
- Errorcode
◆ setVehicleHeight()
| native ApiError setVehicleHeight |
( |
double |
heightInMeters | ) |
|
- Parameters
-
| heightInMeters | - the total height in meters |
- Returns
- Errorcode
◆ setVehicleLength()
| native ApiError setVehicleLength |
( |
double |
lengthInMeters | ) |
|
- Parameters
-
| lengthInMeters | - the total length in meters |
- Returns
- Errorcode
◆ setVehicleLoading()
| native ApiError setVehicleLoading |
( |
int |
loading | ) |
|
- Parameters
-
| loading | - set the loading bitmask of the vehicle (additive combination of enum VehicleLoadType) |
- Returns
- Errorcode
◆ setVehicleLoadingTRC()
- Parameters
-
| loadingTRC | - set the loading TRC (tunnel restriction code) |
- Returns
- Errorcode
◆ setVehicleNumAxles()
| native ApiError setVehicleNumAxles |
( |
int |
numAxles | ) |
|
- Parameters
-
| numAxles | count of vehicle axles |
- Returns
- Errorcode
◆ setVehicleNumTrailers()
| native ApiError setVehicleNumTrailers |
( |
int |
numTrailers | ) |
|
- Parameters
-
| numAxles | count of vehicle trailers |
- Returns
- Errorcode
◆ setVehicleTotalWeight()
| native ApiError setVehicleTotalWeight |
( |
double |
totalWeightInKilograms | ) |
|
- Parameters
-
| totalWeightInKilograms | - the total weight in Kg |
- Returns
- Errorcode
◆ setVehicleWeightPerAxle()
| native ApiError setVehicleWeightPerAxle |
( |
double |
weightPerAxleInKilograms | ) |
|
- Parameters
-
| weightPerAxleInKilograms | weight to set in Kg |
- Returns
- Errorcode
◆ setVehicleWidth()
| native ApiError setVehicleWidth |
( |
double |
widthInMeters | ) |
|
- Parameters
-
| widthInMeters | - vehicle width |
- Returns
- Errorcode
The documentation for this class was generated from the following file: