Package com.mapfactor.sdk.routing

Interface VehicleParams

public interface VehicleParams

Vehicle parameters

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	VehicleParams.RouteOptimization	Route computation optimization type
static enum	VehicleParams.TruckParameter	Large vehicle parameters.

Method Summary

Modifier and Type	Method	Description
String	getId()	Get vehicle id
int	getMaxSpeed()	Get vehicle maximum speed
String	getName()	Get vehicle name
RoadCategoryParams	getRoadCategoryParams(RoadCategory roadCategory)	Get vehicle speed limits for a specific road category
VehicleParams.RouteOptimization	getRouteOptimization()	Get route optimization mode
float	getTruckParameter(VehicleParams.TruckParameter parameter)	Get truck parameter value
float	getTruckParameterMaxValue(VehicleParams.TruckParameter parameter)	Get maximal truck parameter value
Vehicle.VehicleType	getType()	Get vehicle type
void	setMaxSpeed(int speedKmPH)	Set vehicle maximum speed
boolean	setName(String newName)	Set vehicle name
void	setRoadCategoryParams(RoadCategory roadCategory, Boolean isClosed, Integer speedExtraUrban, Integer speedUrban)	Set vehicle speed limits for a specific road category
void	setRouteOptimization(VehicleParams.RouteOptimization optimization)	Set route optimization mode
boolean	setTruckParameter(VehicleParams.TruckParameter parameter, float value)	Set truck parameter value

Method Details

getId

@NonNull
String getId()

Get vehicle id

Returns:

vehicle unique ID

Since:

1.0

getType

@NonNull
Vehicle.VehicleType getType()

Get vehicle type

Returns:

vehicle type

Since:

1.0

getName

@NonNull
String getName()

Get vehicle name

Returns:

vehicle name

Since:

1.0

setName

boolean setName(@NonNull
 String newName)

Set vehicle name

Parameters:

newName - new vehicle profile name

Returns:

true on success, false when a vehicle profile with the same name already existed

Since:

4.3

getMaxSpeed

int getMaxSpeed()

Get vehicle maximum speed

Returns:

vehicle maximum speed in km/h

Since:

1.0

setMaxSpeed

void setMaxSpeed(int speedKmPH)

Set vehicle maximum speed

Parameters:

speedKmPH - speed in km/h

Since:

1.0

getRoadCategoryParams

@NonNull
RoadCategoryParams getRoadCategoryParams(@NonNull
 RoadCategory roadCategory)

Get vehicle speed limits for a specific road category

Parameters:

roadCategory - road category to get parameters for

Returns:

road category parameters for roadCategory

Since:

1.0

setRoadCategoryParams

void setRoadCategoryParams(@NonNull
 RoadCategory roadCategory,
 @Nullable
 Boolean isClosed,
 @Nullable
 Integer speedExtraUrban,
 @Nullable
 Integer speedUrban)

Set vehicle speed limits for a specific road category

Parameters:

roadCategory - road category to change parameters

isClosed - True/False to close/open roads of the category for routing or null to keep current value

speedExtraUrban - value in km/h to set speed outside towns or null to keep current value

speedUrban - value in km/h to set speed within towns or null to keep current value

Since:

1.0

getRouteOptimization

@NonNull
VehicleParams.RouteOptimization getRouteOptimization()

Get route optimization mode

Returns:

current route calculation optimization mode

Since:

1.0

setRouteOptimization

void setRouteOptimization(@NonNull
 VehicleParams.RouteOptimization optimization)

Set route optimization mode

Parameters:

optimization - route calculation optimization mode

Since:

1.0

setTruckParameter

boolean setTruckParameter(@NonNull
 VehicleParams.TruckParameter parameter,
 float value)

Set truck parameter value

Parameters:

parameter - truck parameter to set

value - truck parameter value

Returns:

false if not licensed, true otherwise

Since:

1.0

getTruckParameter

float getTruckParameter(@NonNull
 VehicleParams.TruckParameter parameter)

Get truck parameter value

Parameters:

parameter - truck parameter to get

Returns:

truck parameter value

Since:

1.0

getTruckParameterMaxValue

float getTruckParameterMaxValue(@NonNull
 VehicleParams.TruckParameter parameter)

Get maximal truck parameter value

Parameters:

parameter - truck parameter maximal value to get

Returns:

truck parameter maximal value

Since:

1.0