EVCarOptions (API Reference)
Class EVCarOptions
All the options to specify how a route for an electric car should be calculated.
At minimum, a valid EVConsumptionModel must be set or the route calculation will fail.
Note: ensureReachability must be true to make sure that all stopovers are reachable. For this,
charging stations may be added to the route. If ensureReachability is 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
FieldsModifier and TypeFieldDescriptionDeprecated.The options explicitly allowed by user for route calculations.Deprecated.Options to specify restrictions for route calculations.Deprecated.Parameters that describe the electric vehicle's battery.Deprecated.Detailed car specifications such as dimensions and weight.Deprecated.Vehicle specific parameters, which are then used to calculate energy consumption for the vehicle on a given route.booleanDeprecated.Ensure that the vehicle does not run out of energy along the way.Deprecated.Defines the preferred E-Mobility Service Providers.Deprecated.Specifies the last character of a vehicle's license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones.Deprecated.Segments with restriction on maximumDynamicSpeedInfo.baseSpeedInMetersPerSecond.intDeprecated.Specifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes.Deprecated.Specifies the common route calculation options.Deprecated.Customize textual content returned from the route calculation, such as localization, format, and unit system.Deprecated.Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
routeOptions
Deprecated.Specifies the common route calculation options.
-
textOptions
Deprecated.Customize textual content returned from the route calculation, such as localization, format, and unit system.
-
avoidanceOptions
Deprecated.Options to specify restrictions for route calculations. By default no restrictions are applied.
-
tollOptions
Deprecated.Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type.
-
allowOptions
Deprecated.The options explicitly allowed by user for route calculations. By default no options are opt in.
-
occupantsNumber
public int occupantsNumberDeprecated.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
Deprecated.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
Deprecated.Segments with restriction on maximum
DynamicSpeedInfo.baseSpeedInMetersPerSecond. -
ensureReachability
public boolean ensureReachabilityDeprecated.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
Deprecated.Vehicle specific parameters, which are then used to calculate energy consumption for the vehicle on a given route.
-
batterySpecifications
Deprecated.Parameters that describe the electric vehicle's battery.
-
carSpecifications
Deprecated.Detailed car specifications such as dimensions and weight.
-
evMobilityServiceProviderPreferences
Deprecated.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.
-
-
Constructor Details
-
EVCarOptions
public EVCarOptions()Deprecated.Creates a new instance.
-
-
Method Details
Will be removed in v4.28.0. Use
RoutingOptionsclass instead.