ChargingStop (API Reference)
Class ChargingStop
The options to specify a user-planned charging stop.
Note:
In order to specify this ChargingStop, it is also required to set
[sdk.routing.BatterySpecifications.total_capacity_in_kilowatt_hours], [sdk.routing.BatterySpecifications.initial_charge_in_kilowatt_hours],
and [sdk.routing.BatterySpecifications.charging_curve].
Without all of them, the route calculation will fail as an invalid parameter error.
-
Field Summary
FieldsModifier and TypeFieldDescriptiondoubleThe value of rated current of the connector (in A).The maximum duration the user plans to charge at the station, includingBatterySpecifications.chargingSetupDuration.The minimum duration the user expects to charge at the station, includingBatterySpecifications.chargingSetupDuration.doubleThe value of rated power of the connector (in kW).Supply type of the suggested connector.doubleThe value of rated voltage of the connector (in V). -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance.ChargingStop(double powerInKilowatts, double currentInAmperes, double voltageInVolts, ChargingSupplyType supplyType, Duration minDuration, Duration maxDuration) Creates a new instance. -
Method Summary
-
Field Details
-
powerInKilowatts
public double powerInKilowattsThe value of rated power of the connector (in kW).
-
currentInAmperes
public double currentInAmperesThe value of rated current of the connector (in A).
-
voltageInVolts
public double voltageInVoltsThe value of rated voltage of the connector (in V).
-
supplyType
Supply type of the suggested connector.
-
minDuration
The minimum duration the user expects to charge at the station, including
BatterySpecifications.chargingSetupDuration. Note: At least one ofmin_durationandmax_durationis required for a user-planned charging stop. For most use cases, providing at leastmin_durationis recommended. -
maxDuration
The maximum duration the user plans to charge at the station, including
BatterySpecifications.chargingSetupDuration. Note: At least one ofmin_durationandmax_durationis required for a user-planned charging stop. For most use cases, providing at leastmin_durationis recommended.
-
-
Constructor Details
-
ChargingStop
public ChargingStop()Creates a new instance.
-
ChargingStop
public ChargingStop(double powerInKilowatts, double currentInAmperes, double voltageInVolts, @Nullable ChargingSupplyType supplyType, @Nullable Duration minDuration, @Nullable Duration maxDuration) Creates a new instance.
- Parameters:
powerInKilowatts-The value of rated power of the connector (in kW).
currentInAmperes-The value of rated current of the connector (in A).
voltageInVolts-The value of rated voltage of the connector (in V).
supplyType-Supply type of the suggested connector.
minDuration-The minimum duration the user expects to charge at the station, including
BatterySpecifications.chargingSetupDuration. Note: At least one ofmin_durationandmax_durationis required for a user-planned charging stop. For most use cases, providing at leastmin_durationis recommended.maxDuration-The maximum duration the user plans to charge at the station, including
BatterySpecifications.chargingSetupDuration. Note: At least one ofmin_durationandmax_durationis required for a user-planned charging stop. For most use cases, providing at leastmin_durationis recommended.
-
-
Method Details