Class EVCarOptions
Class EVCarOptions
- java.lang.Object
-
- com.here.sdk.routing.EVCarOptions
-
public final class EVCarOptions extends java.lang.ObjectAll the options to specify how a route for an electric car should be calculated. At minimum, a valid
EVConsumptionModelmust be set or the route calculation will fail.
Note:ensureReachabilitymust betrueto make sure that all stopovers are reachable. For this, charging stations may be added to the route. IfensureReachabilityis true, you need to specify the required route options and battery specifications that include the current charge level of the battery (BatterySpecifications.initialChargeInKilowattHours). See the parameter description below for more details.
-
-
Field Summary
Fields Modifier and Type Field Description AllowOptionsallowOptionsThe options explicitly allowed by user for route calculations.AvoidanceOptionsavoidanceOptionsOptions to specify restrictions for route calculations.BatterySpecificationsbatterySpecificationsParameters that describe the electric vehicle's battery.CarSpecificationscarSpecificationsDetailed car specifications such as dimensions and weight.EVConsumptionModelconsumptionModelVehicle specific parameters, which are then used to calculate energy consumption for the vehicle on a given route.booleanensureReachabilityEnsure that the vehicle does not run out of energy along the way.EVMobilityServiceProviderPreferencesevMobilityServiceProviderPreferencesDefines the preferred E-Mobility Service Providers.java.lang.StringlastCharacterOfLicensePlateSpecifies the last character of a vehicle's license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones.java.util.List<MaxSpeedOnSegment>maxSpeedOnSegmentsSegments with restriction on maximumDynamicSpeedInfo.baseSpeedInMetersPerSecond.intoccupantsNumberSpecifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes.RouteOptionsrouteOptionsSpecifies the common route calculation options.RouteTextOptionstextOptionsCustomize textual content returned from the route calculation, such as localization, format, and unit system.TollOptionstollOptionsOptions to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type.
-
Constructor Summary
Constructors Constructor Description EVCarOptions()Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)inthashCode()
-
-
-
Field Detail
-
routeOptions
@NonNull public RouteOptions routeOptions
Specifies the common route calculation options.
-
textOptions
@NonNull public RouteTextOptions textOptions
Customize textual content returned from the route calculation, such as localization, format, and unit system.
-
avoidanceOptions
@NonNull public AvoidanceOptions avoidanceOptions
Options to specify restrictions for route calculations. By default no restrictions are applied.
-
tollOptions
@NonNull public TollOptions tollOptions
Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type.
-
allowOptions
@NonNull public AllowOptions allowOptions
The options explicitly allowed by user for route calculations. By default no options are opt in.
-
occupantsNumber
public int occupantsNumber
Specifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes. Shouldn't be less than 1 or greater than 255. Defaults to 1.
Note: This parameter has no effect unless HOV and/or HOT lane usage is enabled via
allowOptionsand such lanes are available in the selected country.
-
lastCharacterOfLicensePlate
@Nullable public java.lang.String lastCharacterOfLicensePlate
Specifies the last character of a vehicle's license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones. In cities like Bogotá, Mexico City, or Jakarta, specific license plate digits may be restricted on certain days or in certain areas to reduce congestion and emissions. When this value is provided, the HERE SDK considers it during route calculation to avoid roads or areas where your vehicle may be restricted based on local regulations. Example usage: "7", when the license plate of a vehicle looks like "B-ET-182487".
If this value is not set, such license plate-based restrictions are ignored, and routing is performed without considering them.
-
maxSpeedOnSegments
@NonNull public java.util.List<MaxSpeedOnSegment> maxSpeedOnSegments
Segments with restriction on maximum
DynamicSpeedInfo.baseSpeedInMetersPerSecond.
-
ensureReachability
public boolean ensureReachability
Ensure that the vehicle does not run out of energy along the way. Requires valid
batterySpecifications. It also requires thatRouteOptions.optimizationMode=OptimizationMode.FASTEST,RouteOptions.speedCapInMetersPerSecondis not set, andAvoidanceOptionsis empty. Otherwise, this object is considered invalid. Setting this flag enables calculation of a route optimized for electric vehicles. Charging stations may be added along the route to ensure that the vehicle does not run out of energy along the way. It is especially useful for longer routes, because after all, charging stations are much less common than petrol stations. Note An [sdk.routing.RoutingError.INVALID_PARAMETER] is generated when the [sdk.routing.EVCarOptions.ensure_reachability] is set totruein case [sdk.routing.RoutingEngine.import_route] is called. Defaults tofalse.
-
consumptionModel
@NonNull public EVConsumptionModel consumptionModel
Vehicle specific parameters, which are then used to calculate energy consumption for the vehicle on a given route.
-
batterySpecifications
@NonNull public BatterySpecifications batterySpecifications
Parameters that describe the electric vehicle's battery.
-
carSpecifications
@NonNull public CarSpecifications carSpecifications
Detailed car specifications such as dimensions and weight.
-
evMobilityServiceProviderPreferences
@NonNull public EVMobilityServiceProviderPreferences evMobilityServiceProviderPreferences
Defines the preferred E-Mobility Service Providers. The The E-Mobility Service Provider Partner Ids can be received from https://www.here.com/docs/bundle/ev-charge-points-api-developer-guide/page/topics/resource-roamings.html An alternative way to get
partnerIdis theeMobilityServiceProviders.partnerIdas part ofHERE SDK Search. Maximum number of E-Mobility Service Providers is limited to 10. By default, all providers are used.
-
-