HERE Android SDK Developer's Guide

TruckRestrictionsMode

The enumeration TruckRestrictionsMode is a member of com.here.android.mpa.routing.RouteOptions.

Enumeration Summary

public static final enumeration RouteOptions.TruckRestrictionsMode

extends java.lang.Enum, java.lang.Object

Defines way of handling road segments on which violated static truck restriction applies.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 1. Enum Constants in TruckRestrictionsMode
Fields

public static final TruckRestrictionsMode NO_VIOLATIONS

In those mode violating road segments will not be part of the route.

public static final TruckRestrictionsMode PENALIZE_VIOLATIONS

In those mode violating road segments can be part of the route, if no other route can be calculated.

Method Summary

Table 2. Methods in TruckRestrictionsMode
Methods

public static TruckRestrictionsMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static RouteOptions.TruckRestrictionsMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines way of handling road segments on which violated static truck restriction applies. When mode is set to NO_VIOLATIONS then such segments will not be part of the route. PENALIZE_VIOLATIONS is relaxed way of handling restrictions. Streets where truck restrictions are violated will be avoided, but if there is no way around route will go through restricted streets. WARNING: Route calculated with this option cannot be used for navigation. Typical use case is route calculation with imprecise start/destination for planning purpose when user wants to know some statistics data like estimated length, countries crossed. With this option route will be calculated even if it starts/ends in restricted areas. When no mode is explicitly set NO_VIOLATIONS mode is used for route calculation. This option does not affect time dependent truck restrictions.

Enum Constant Details

public static final TruckRestrictionsMode NO_VIOLATIONS

In those mode violating road segments will not be part of the route.

public static final TruckRestrictionsMode PENALIZE_VIOLATIONS

In those mode violating road segments can be part of the route, if no other route can be calculated.

Method Details

public static TruckRestrictionsMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

  • name

    A string containing the name of the enumeration member whose value is to be retrieved.

public static RouteOptions.TruckRestrictionsMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.