MapTrip SDK Android Manual 9.9.7
VehicleProfile Class Reference

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...

+ Inheritance diagram for VehicleProfile:

Public Member Functions

boolean equals (Object o)
 
native String getProfileName ()
 
boolean getVehicleAttributesEnabled ()
 
native double getVehicleHeight ()
 
native double getVehicleLength ()
 
native int getVehicleLoading ()
 
native VehicleLoadTrc getVehicleLoadingTRC ()
 
native int getVehicleNumAxles ()
 
native int getVehicleNumTrailers ()
 
native double getVehicleTotalWeight ()
 
native VehicleType getVehicleType ()
 
native double getVehicleWeightPerAxle ()
 
native double getVehicleWidth ()
 
ApiError setAsActiveProfile ()
 
ApiError setVehicleAttributesEnabled (final boolean enabled)
 
native ApiError setVehicleHeight (double heightInMeters)
 
native ApiError setVehicleLength (double lengthInMeters)
 
native ApiError setVehicleLoading (int loading)
 
native ApiError setVehicleLoadingTRC (VehicleLoadTrc loadingTRC)
 
native ApiError setVehicleNumAxles (int numAxles)
 
native ApiError setVehicleNumTrailers (int numTrailers)
 
native ApiError setVehicleTotalWeight (double totalWeightInKilograms)
 
native ApiError setVehicleWeightPerAxle (double weightPerAxleInKilograms)
 
native ApiError setVehicleWidth (double widthInMeters)
 

Static Public Member Functions

static native VehicleProfile getActiveProfile ()
 
static native Iterable< VehicleProfilegetVehicleProfileIterator ()
 
static native Iterable< VehicleProfilegetVehicleProfileIteratorByName (String name)
 

Detailed Description

Vehicle profiles can have extended attributes (wheight per axle, length, height etc.). Those have to be activated separately (see VehicleProfile.getVehicleAttributesEnabled())

Member Function Documentation

◆ equals()

boolean equals ( Object  o)
inherited

◆ getActiveProfile()

static native VehicleProfile getActiveProfile ( )
static

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 ( )

Returns
height in meters

◆ getVehicleLength()

native double getVehicleLength ( )

Returns
vehicle length in meters

◆ getVehicleLoading()

native int getVehicleLoading ( )

Returns
vehicle loading bitmask (additive combination of enum VehicleLoadType)

◆ getVehicleLoadingTRC()

native VehicleLoadTrc getVehicleLoadingTRC ( )

Returns
The loading TRC (tunnel restriction code)

◆ getVehicleNumAxles()

native int getVehicleNumAxles ( )

Returns
axle count

◆ getVehicleNumTrailers()

native int getVehicleNumTrailers ( )

Returns
axle count

◆ 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
nameto search for
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()

native VehicleType 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()

ApiError 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()

native ApiError setVehicleLoadingTRC ( VehicleLoadTrc  loadingTRC)

Parameters
loadingTRC- set the loading TRC (tunnel restriction code)
Returns
Errorcode

◆ setVehicleNumAxles()

native ApiError setVehicleNumAxles ( int  numAxles)

Parameters
numAxlescount of vehicle axles
Returns
Errorcode

◆ setVehicleNumTrailers()

native ApiError setVehicleNumTrailers ( int  numTrailers)

Parameters
numAxlescount 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
weightPerAxleInKilogramsweight 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: