Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
MSDevice_Battery.cpp
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2013-2025 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
20// The Battery parameters for the vehicle
21/****************************************************************************/
22#include <config.h>
23
24#include <algorithm>
32#include <microsim/MSNet.h>
33#include <microsim/MSLane.h>
34#include <microsim/MSEdge.h>
35#include <microsim/MSVehicle.h>
37#include "MSDevice_Emissions.h"
38#include "MSDevice_Battery.h"
39
40#define DEFAULT_MAX_CAPACITY 35000
41#define DEFAULT_CHARGE_RATIO 0.5
42
43
44// ===========================================================================
45// method definitions
46// ===========================================================================
47// ---------------------------------------------------------------------------
48// static initialisation methods
49// ---------------------------------------------------------------------------
50void
52 insertDefaultAssignmentOptions("battery", "Battery", oc);
53 // custom options
54 oc.doRegister("device.battery.track-fuel", new Option_Bool(false));
55 oc.addDescription("device.battery.track-fuel", "Battery", TL("Track fuel consumption for non-electric vehicles"));
56}
57
58
59void
60MSDevice_Battery::buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into, MSDevice_StationFinder* sf) {
61 // Check if vehicle should get a battery
62 if (sf != nullptr || equippedByDefaultAssignmentOptions(OptionsCont::getOptions(), "battery", v, false)) {
63 // obtain parameter values
64 const double maximumBatteryCapacity = readParameterValue(v, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, "battery.capacity", DEFAULT_MAX_CAPACITY);
65 const double actualBatteryCapacity = readParameterValue(v, SUMO_ATTR_ACTUALBATTERYCAPACITY, "battery.chargeLevel", maximumBatteryCapacity * DEFAULT_CHARGE_RATIO);
66 const double stoppingThreshold = readParameterValue(v, SUMO_ATTR_STOPPINGTHRESHOLD, "battery.stoppingThreshold", 0.1);
67 const double maximumChargeRate = readParameterValue(v, SUMO_ATTR_MAXIMUMCHARGERATE, "battery.maximumChargeRate", 150000.);
68 const std::string chargeLevelTable = v.getStringParam("device.battery.chargeLevelTable");
69 const std::string chargeCurveTable = v.getStringParam("device.battery.chargeCurveTable");
70
71 // battery constructor
72 MSDevice_Battery* device = new MSDevice_Battery(v, "battery_" + v.getID(),
73 actualBatteryCapacity, maximumBatteryCapacity, stoppingThreshold, maximumChargeRate, chargeLevelTable, chargeCurveTable);
74
75 // Add device to vehicle
76 into.push_back(device);
77
78 if (sf != nullptr) {
79 sf->setBattery(device);
80 }
81 // ensure that parameters are initialized
83 }
84}
85
86
87double
88MSDevice_Battery::readParameterValue(SUMOVehicle& v, const SumoXMLAttr& attr, const std::string& paramName, double defaultVal) {
89 const std::string& oldParam = toString(attr);
90 const SUMOVTypeParameter& typeParams = v.getVehicleType().getParameter();
91 if (v.getParameter().hasParameter(oldParam) || typeParams.hasParameter(oldParam)) {
92 WRITE_WARNINGF(TL("Battery device in vehicle '%' still uses old parameter '%'. Please update to 'device.%'."), v.getID(), oldParam, paramName);
93 if (v.getParameter().getParameter(oldParam, "-") == "-") {
94 return typeParams.getDouble(oldParam, defaultVal);
95 }
96 return StringUtils::toDouble(v.getParameter().getParameter(oldParam, "0"));
97 }
98 return v.getFloatParam("device." + paramName, false, defaultVal);
99}
100
101
102// ---------------------------------------------------------------------------
103// MSDevice_Battery-methods
104// ---------------------------------------------------------------------------
105MSDevice_Battery::MSDevice_Battery(SUMOVehicle& holder, const std::string& id, const double actualBatteryCapacity, const double maximumBatteryCapacity,
106 const double stoppingThreshold, const double maximumChargeRate, const std::string& chargeLevelTable, const std::string& chargeCurveTable) :
107 MSVehicleDevice(holder, id),
108 myActualBatteryCapacity(0), // [actualBatteryCapacity <= maximumBatteryCapacity]
109 myMaximumBatteryCapacity(0), // [maximumBatteryCapacity >= 0]
110 myStoppingThreshold(0), // [stoppingThreshold >= 0]
111 myMaximumChargeRate(0),
112 myChargeLimit(-1),
113 myLastAngle(std::numeric_limits<double>::infinity()),
114 myChargingStopped(false), // Initially vehicle don't charge stopped
115 myChargingInTransit(false), // Initially vehicle don't charge in transit
116 myChargingStartTime(0), // Initially charging start time (must be if the vehicle was launched at the charging station)
117 myConsum(0), // Initially the vehicle is stopped and therefore the consum is zero.
118 myTotalConsumption(0.0),
119 myTotalRegenerated(0.0),
120 myActChargingStation(nullptr), // Initially the vehicle isn't over a Charging Station
121 myPreviousNeighbouringChargingStation(nullptr), // Initially the vehicle wasn't over a Charging Station
122 myEnergyCharged(0), // Initially the energy charged is zero
123 myVehicleStopped(0),
124 myDepletedCount(0) {
125 // Initially the vehicle is stopped and the corresponding variable is 0
126
127 if (maximumBatteryCapacity < 0) {
128 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
129 } else {
130 myMaximumBatteryCapacity = maximumBatteryCapacity;
131 }
132
133 if (actualBatteryCapacity > maximumBatteryCapacity) {
134 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' has a % (%) greater than its % (%). A max battery capacity value will be assigned."),
135 getID(), toString(SUMO_ATTR_ACTUALBATTERYCAPACITY), toString(actualBatteryCapacity), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
137 } else {
138 myActualBatteryCapacity = actualBatteryCapacity;
139 }
140
141 if (stoppingThreshold < 0) {
142 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_STOPPINGTHRESHOLD), toString(stoppingThreshold));
143 } else {
144 myStoppingThreshold = stoppingThreshold;
145 }
146
147 myTrackFuel = PollutantsInterface::getFuel(holder.getVehicleType().getEmissionClass()) != "Electricity" && OptionsCont::getOptions().getBool("device.battery.track-fuel");
149 WRITE_WARNINGF(TL("The battery device is active for vehicle '%' but no emission class is set. "
150 "Please consider setting an explicit emission class or battery outputs might be inconsistent with emission outputs!"),
151 holder.getID());
152 }
154
155 if (maximumChargeRate < 0) {
156 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMCHARGERATE), toString(maximumChargeRate));
157 } else {
158 if (!chargeLevelTable.empty() && !chargeCurveTable.empty()) {
159 LinearApproxHelpers::setPoints(myChargeCurve, chargeLevelTable, chargeCurveTable);
161 } else {
162 myMaximumChargeRate = maximumChargeRate;
163 }
164 }
165}
166
167
170
171
172bool MSDevice_Battery::notifyMove(SUMOTrafficObject& tObject, double /* oldPos */, double /* newPos */, double /* newSpeed */) {
173 if (!tObject.isVehicle()) {
174 return false;
175 }
176 SUMOVehicle& veh = static_cast<SUMOVehicle&>(tObject);
177 // Start vehicleStoppedTimer if the vehicle is stopped. In other case reset timer
178 if (veh.getSpeed() < myStoppingThreshold) {
179 // Increase vehicle stopped timer
181 } else {
182 // Reset vehicle Stopped
184 }
185
186 // Update Energy from the battery
188 if (getMaximumBatteryCapacity() != 0) {
190 // no explicit emission class, we fall back to the energy model; a warning has been issued on creation
192 veh.getSlope(), params) * TS;
193 } else {
196 veh.getSpeed(), veh.getAcceleration(),
197 veh.getSlope(), params) * TS;
198 }
199 if (veh.isParking()) {
200 // recuperation from last braking step is ok but further consumption should cease
201 myConsum = MIN2(myConsum, 0.0);
202 }
203
204 // saturate between 0 and myMaximumBatteryCapacity [Wh]
207 if (myDepletedCount == 1) {
208 WRITE_WARNINGF(TL("Battery of vehicle '%' is depleted, time=%."), veh.getID(), time2string(SIMSTEP));
209 }
210 }
211
212 // Energy lost/gained from vehicle movement (via vehicle energy model) [Wh]
214
215 // Track total energy consumption and regeneration
216 if (myConsum > 0.0) {
218 } else {
220 }
221
222 myLastAngle = veh.getAngle();
223 }
224
225 // Check if vehicle has under their position one charge Station
226 const std::string chargingStationID = MSNet::getInstance()->getStoppingPlaceID(veh.getLane(), veh.getPositionOnLane(), SUMO_TAG_CHARGING_STATION);
227
228 // If vehicle is over a charging station
229 if (chargingStationID != "") {
230 // if the vehicle is almost stopped, or charge in transit is enabled, then charge vehicle
232 const MSParkingArea* pa = cs->getParkingArea();
233 if (((veh.getSpeed() < myStoppingThreshold) || cs->getChargeInTransit()) && (pa == nullptr || veh.isParking()) && cs->getChargeType() == myChargeType) {
234 // Set Flags Stopped/intransit to
235 if (veh.getSpeed() < myStoppingThreshold) {
236 // vehicle ist almost stopped, then is charging stopped
237 myChargingStopped = true;
238
239 // therefore isn't charging in transit
240 myChargingInTransit = false;
241 } else {
242 // vehicle is moving, and the Charging station allow charge in transit
243 myChargingStopped = false;
244
245 // Therefore charge in transit
246 myChargingInTransit = true;
247 }
248
249 // get pointer to charging station
251
252 // Only update charging start time if vehicle allow charge in transit, or in other case
253 // if the vehicle not allow charge in transit but it's stopped.
255 // Update Charging start time
257 }
258
259 // time it takes the vehicle at the station < charging station time delay?
261 // Enable charging vehicle
263
264 // Calulate energy charged
266
267 // Update Battery charge
269 }
270 // add charge value for output to myActChargingStation
272 }
273 // else disable charging vehicle
274 else {
275 cs->setChargingVehicle(false);
276 }
277 // disable charging vehicle from previous (not current) ChargingStation (reason: if there is no gap between two different chargingStations = the vehicle switches from used charging station to other one in a single timestap)
280 }
282 }
283 // In other case, vehicle will be not charged
284 else {
285 // Disable flags
286 myChargingInTransit = false;
287 myChargingStopped = false;
288
289 // Disable charging vehicle
290 if (myActChargingStation != nullptr) {
292 }
293
294 // Set charging station pointer to NULL
295 myActChargingStation = nullptr;
296
297 // Set energy charged to 0
298 myEnergyCharged = 0;
299
300 // Reset timer
302 }
303
304 // Always return true.
305 return true;
306}
307
308
309void
313 std::vector<std::string> internals;
314 internals.push_back(toString(myActualBatteryCapacity));
315 internals.push_back(toString(myLastAngle));
316 internals.push_back(toString(myChargingStopped));
317 internals.push_back(toString(myChargingInTransit));
318 internals.push_back(toString(myChargingStartTime));
319 internals.push_back(toString(myTotalConsumption));
320 internals.push_back(toString(myTotalRegenerated));
321 internals.push_back(toString(myEnergyCharged));
322 internals.push_back(toString(myVehicleStopped));
323 internals.push_back(getChargingStationID());
324 std::string prevChargingID = (myPreviousNeighbouringChargingStation == nullptr) ? "NULL" : myPreviousNeighbouringChargingStation->getID();
325 internals.push_back(prevChargingID);
326 internals.push_back(toString(myMaximumChargeRate));
327 out.writeAttr(SUMO_ATTR_STATE, toString(internals));
328 out.closeTag();
329}
330
331
332void
334 std::istringstream bis(attrs.getString(SUMO_ATTR_STATE));
336 bis >> myLastAngle;
337 bis >> myChargingStopped;
338 bis >> myChargingInTransit;
339 bis >> myChargingStartTime;
340 bis >> myTotalConsumption;
341 bis >> myTotalRegenerated;
342 bis >> myEnergyCharged;
343 bis >> myVehicleStopped;
344 std::string chargingID;
345 bis >> chargingID;
346 if (chargingID != "NULL") {
348 }
349 std::string prevChargingID;
350 bis >> prevChargingID;
351 if (prevChargingID != "NULL") {
353 }
354 bis >> myMaximumChargeRate;
355}
356
357
358void
359MSDevice_Battery::setActualBatteryCapacity(const double actualBatteryCapacity) {
360 if (actualBatteryCapacity < 0) {
362 } else if (actualBatteryCapacity > myMaximumBatteryCapacity) {
364 } else {
365 myActualBatteryCapacity = actualBatteryCapacity;
366 }
367}
368
369
370void
371MSDevice_Battery::setMaximumBatteryCapacity(const double maximumBatteryCapacity) {
372 if (myMaximumBatteryCapacity < 0) {
373 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
374 } else {
375 myMaximumBatteryCapacity = maximumBatteryCapacity;
376 }
377}
378
379
380void
381MSDevice_Battery::setStoppingThreshold(const double stoppingThreshold) {
382 if (stoppingThreshold < 0) {
383 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_STOPPINGTHRESHOLD), toString(stoppingThreshold));
384 } else {
385 myStoppingThreshold = stoppingThreshold;
386 }
387}
388
389
390void
392 if (chargeRate < 0) {
393 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMCHARGERATE), toString(chargeRate));
394 } else {
395 myMaximumChargeRate = chargeRate;
396 }
397}
398
399
400void
402 myChargeLimit = limit;
403}
404
405
406void
410
411
412void
416
417
418void
422
423
424void
428
429
430void
431MSDevice_Battery::setEnergyCharged(const double energyCharged) {
432 myEnergyCharged = energyCharged;
433}
434
435
436double
440
441
442double
446
447
448double
450 return myConsum;
451}
452
453double
457
458
459double
463
464
465bool
469
470
471bool
475
476
481
482
484MSDevice_Battery::estimateChargingDuration(const double toCharge, const double csPower) const {
485 //if (!myChargeCurve.empty()) {
486 // // TODO: integrate charge curve
487 //}
488 return TIME2STEPS(toCharge / MIN2(csPower, myMaximumChargeRate));
489}
490
491
492std::string
494 if (myActChargingStation != nullptr) {
495 return myActChargingStation->getID();
496 } else {
497 return "NULL";
498 }
499}
500
501double
505
506
507int
511
512
513double
517
518
519double
524
525
526bool
528 return myTrackFuel;
529}
530
531
536
537
538std::string
539MSDevice_Battery::getParameter(const std::string& key) const {
541 || key == toString(SUMO_ATTR_CHARGELEVEL)) {
543 } else if (key == toString(SUMO_ATTR_ENERGYCONSUMED)) {
544 return toString(getConsum());
545 } else if (key == "chargePower") {
546 return toString(getEnergyCharged() * 3600.);
547 } else if (key == "usedAverage") {
549 } else if (key == toString(SUMO_ATTR_TOTALENERGYCONSUMED)) {
551 } else if (key == toString(SUMO_ATTR_TOTALENERGYREGENERATED)) {
553 } else if (key == toString(SUMO_ATTR_ENERGYCHARGED)) {
554 return toString(getEnergyCharged());
555 } else if (key == toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY) || key == "capacity") {
557 } else if (key == toString(SUMO_ATTR_MAXIMUMCHARGERATE)) {
559 } else if (key == toString(SUMO_ATTR_CHARGINGSTATIONID)) {
560 return getChargingStationID();
561 }
562 throw InvalidArgument("Parameter '" + key + "' is not supported for device of type '" + deviceName() + "'");
563}
564
565
566void
567MSDevice_Battery::setParameter(const std::string& key, const std::string& value) {
568 double doubleValue;
569 try {
570 doubleValue = StringUtils::toDouble(value);
571 } catch (NumberFormatException&) {
572 throw InvalidArgument("Setting parameter '" + key + "' requires a number for device of type '" + deviceName() + "'");
573 }
575 setActualBatteryCapacity(doubleValue);
576 } else if (key == toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY) || key == "capacity") {
577 setMaximumBatteryCapacity(doubleValue);
578 } else if (key == toString(SUMO_ATTR_MAXIMUMCHARGERATE)) {
579 setMaximumChargeRate(doubleValue);
580 } else {
581 throw InvalidArgument("Setting parameter '" + key + "' is not supported for device of type '" + deviceName() + "'");
582 }
583}
584
585
586void
588 // @note: only charing is performed but no energy is consumed
590 myConsum = 0;
591}
592
593
594void
596 if (tripinfoOut != nullptr) {
597 tripinfoOut->openTag("battery");
598 tripinfoOut->writeAttr("depleted", toString(myDepletedCount));
599 tripinfoOut->writeAttr("actualBatteryCapacity", toString(myActualBatteryCapacity));
600 tripinfoOut->writeAttr("totalEnergyConsumed", toString(myTotalConsumption));
601 tripinfoOut->writeAttr("totalEnergyRegenerated", toString(myTotalRegenerated));
602 tripinfoOut->closeTag();
603 }
604}
605
606
607/****************************************************************************/
long long int SUMOTime
Definition GUI.h:36
#define DEFAULT_CHARGE_RATIO
#define DEFAULT_MAX_CAPACITY
#define WRITE_WARNINGF(...)
Definition MsgHandler.h:287
#define TL(string)
Definition MsgHandler.h:304
SUMOTime DELTA_T
Definition SUMOTime.cpp:38
std::string time2string(SUMOTime t, bool humanReadable)
convert SUMOTime to string (independently of global format setting)
Definition SUMOTime.cpp:91
#define STEPS2TIME(x)
Definition SUMOTime.h:55
#define SIMSTEP
Definition SUMOTime.h:61
#define TS
Definition SUMOTime.h:42
#define TIME2STEPS(x)
Definition SUMOTime.h:57
const long long int VTYPEPARS_EMISSIONCLASS_SET
@ SUMO_TAG_DEVICE
@ SUMO_TAG_CHARGING_STATION
A Charging Station.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
@ SUMO_ATTR_CHARGELEVEL
@ SUMO_ATTR_ENERGYCONSUMED
Energy consumed.
@ SUMO_ATTR_MAXIMUMBATTERYCAPACITY
Maxium battery capacity.
@ SUMO_ATTR_MAXIMUMCHARGERATE
Maximum Power.
@ SUMO_ATTR_STOPPINGTHRESHOLD
Stopping threshold.
@ SUMO_ATTR_CHARGINGSTATIONID
Charging Station ID.
@ SUMO_ATTR_ACTUALBATTERYCAPACITY
@ SUMO_ATTR_ENERGYCHARGED
tgotal of Energy charged
@ SUMO_ATTR_ID
@ SUMO_ATTR_TOTALENERGYREGENERATED
Total energy regenerated.
@ SUMO_ATTR_TOTALENERGYCONSUMED
Total energy consumed.
@ SUMO_ATTR_STATE
The state of a link.
T MIN2(T a, T b)
Definition StdDefs.h:80
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition ToString.h:46
An upper class for objects with additional parameters.
double compute(const SUMOEmissionClass c, const PollutantsInterface::EmissionType e, const double v, const double a, const double slope, const EnergyParams *param) const
Computes the emitted pollutant amount using the given speed and acceleration.
static double getInterpolatedValue(const LinearApproxMap &map, double axisValue)
Get interpolated value.
static bool setPoints(LinearApproxMap &map, const std::string &axisString, const std::string &heightString)
Set data points.
static double getMaximumValue(const LinearApproxMap &map)
Get the largest height value.
double getChargingPower(bool usingFuel) const
Get charging station's charging power.
bool getChargeInTransit() const
Get chargeInTransit.
void setChargingVehicle(bool value)
enable or disable charging vehicle
void addChargeValueForOutput(double WCharged, MSDevice_Battery *battery)
add charge value for output
SUMOTime getChargeDelay() const
Get Charge Delay.
double getEfficency() const
Get efficiency of the charging station.
ChargeType getChargeType() const
Get charge type.
const MSParkingArea * getParkingArea() const
Get the parking area the charging station is placed on.
Battery device for electric vehicles.
void setEnergyCharged(const double energyCharged)
Set Energy Charged in Wh.
bool notifyMove(SUMOTrafficObject &veh, double oldPos, double newPos, double newSpeed) override
Checks for waiting steps when the vehicle moves.
MSChargingStation::ChargeType getChargeType() const
Get the charge type.
SUMOTime getChargingStartTime() const
Get charging start time.
void saveState(OutputDevice &out) const override
Saves the state of the device.
static void insertOptions(OptionsCont &oc)
Inserts MSDevice_Example-options.
int myVehicleStopped
Parameter, How many timestep the vehicle is stopped.
bool myChargingInTransit
Parameter, Flag: Vehicles it's charging in transit (by default is false)
LinearApproxHelpers::LinearApproxMap myChargeCurve
Charge curve data points storage.
double getActualBatteryCapacity() const
Get the actual vehicle's Battery Capacity in Wh.
int getVehicleStopped() const
Get number of timestep that vehicle is stopped.
void setChargeLimit(const double limit)
Set (temporary) charge limit.
MSDevice_Battery(SUMOVehicle &holder, const std::string &id, const double actualBatteryCapacity, const double maximumBatteryCapacity, const double stoppingThreshold, const double maximumChargeRate, const std::string &chargeLevelTable, const std::string &chargeCurveTable)
Constructor.
double myMaximumBatteryCapacity
Parameter, The total vehicles's Battery Capacity in Wh, [myMaximumBatteryCapacity >= 0].
void increaseVehicleStoppedTimer()
Increase myVehicleStopped.
const std::string deviceName() const override
return the name for this type of device
double myActualBatteryCapacity
Parameter, The actual vehicles's Battery Capacity in Wh, [myActualBatteryCapacity <= myMaximumBattery...
double getMaximumChargeRate() const
Get current charge rate in W depending on the state of charge.
void setParameter(const std::string &key, const std::string &value) override
try to set the given parameter for this device. Throw exception for unsupported key
void increaseChargingStartTime()
Increase Charging Start time.
MSChargingStation * myPreviousNeighbouringChargingStation
Parameter, Pointer to charging station neighbouring with myActChargingStation in which vehicle was pl...
MSChargingStation::ChargeType myChargeType
the accepted charge type
void notifyParking() override
called to update state for parking vehicles
void loadState(const SUMOSAXAttributes &attrs) override
Loads the state of the device from the given description.
void setStoppingThreshold(const double stoppingThreshold)
Set vehicle's stopping threshold.
double getMaximumBatteryCapacity() const
Get the total vehicle's Battery Capacity in Wh.
SUMOTime estimateChargingDuration(const double toCharge, const double csPower) const
Estimate the charging duration given the current battery state.
bool myChargingStopped
Parameter, Flag: Vehicles it's charging stopped (by default is false)
double getConsum() const
Get consum.
void setActualBatteryCapacity(const double actualBatteryCapacity)
Set actual vehicle's Battery Capacity in kWh.
void generateOutput(OutputDevice *tripinfoOut) const override
Called on vehicle deletion to extend tripinfo.
std::string getParameter(const std::string &key) const override
try to retrieve the given parameter from this device. Throw exception for unsupported key
bool myTrackFuel
whether to track fuel consumption instead of electricity
double myEnergyCharged
Parameter, Energy charged in each timestep.
double myLastAngle
Parameter, Vehicle's last angle.
void setMaximumChargeRate(const double chargeRate)
Set vehicle's stopping threshold.
double getStoppingThreshold() const
Get stopping threshold.
double myTotalRegenerated
Parameter, total vehicle energy regeneration.
double myMaximumChargeRate
Parameter, maximum charge rate in W.
SUMOTime myChargingStartTime
Parameter, Moment, which the vehicle has beging to charging.
bool isChargingInTransit() const
Get true if Vehicle it's charging, false if not.
void resetChargingStartTime()
Reset charging start time.
double myTotalConsumption
Parameter, total vehicle energy consumption.
void resetVehicleStoppedTimer()
Reset myVehicleStopped.
bool tracksFuel() const
Whether the battery device is actually used as a tank of a combustion vehicle.
int myDepletedCount
Count how many times the vehicle experienced a depleted battery.
double myChargeLimit
(Temporary) limitation in W of the maximum charge rate = charging strategy result
double getTotalRegenerated() const
Get total regenerated.
double getTotalConsumption() const
Get total consumption.
MSChargingStation * myActChargingStation
Parameter, Pointer to current charging station in which vehicle is placed (by default is NULL)
~MSDevice_Battery()
Destructor.
double myConsum
Parameter, Vehicle consum during a time step (by default is 0.)
double getEnergyCharged() const
Get charged energy.
std::string getChargingStationID() const
Get current Charging Station ID.
void setMaximumBatteryCapacity(const double maximumBatteryCapacity)
Set total vehicle's Battery Capacity in kWh.
static void buildVehicleDevices(SUMOVehicle &v, std::vector< MSVehicleDevice * > &into, MSDevice_StationFinder *sf)
Build devices for the given vehicle, if needed.
static double readParameterValue(SUMOVehicle &v, const SumoXMLAttr &attr, const std::string &paramName, double defaultVal)
Read device parameters from input.
double myStoppingThreshold
Parameter, stopping vehicle threshold [myStoppingThreshold >= 0].
bool isChargingStopped() const
Get true if Vehicle is charging, false if not.
A device which triggers rerouting to nearby charging stations.
void setBattery(MSDevice_Battery *battery)
static void insertDefaultAssignmentOptions(const std::string &deviceName, const std::string &optionsTopic, OptionsCont &oc, const bool isPerson=false)
Adds common command options that allow to assign devices to vehicles.
Definition MSDevice.cpp:157
static bool equippedByDefaultAssignmentOptions(const OptionsCont &oc, const std::string &deviceName, DEVICEHOLDER &v, bool outputOptionSet, const bool isPerson=false)
Determines whether a vehicle should get a certain device.
Definition MSDevice.h:200
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition MSNet.cpp:187
std::string getStoppingPlaceID(const MSLane *lane, const double pos, const SumoXMLTag category) const
Returns the stop of the given category close to the given position.
Definition MSNet.cpp:1488
MSStoppingPlace * getStoppingPlace(const std::string &id, const SumoXMLTag category) const
Returns the named stopping place of the given category.
Definition MSNet.cpp:1467
A lane area vehicles can halt at.
Abstract in-vehicle device.
SUMOVehicle & myHolder
The vehicle that stores the device.
SUMOEmissionClass getEmissionClass() const
Get this vehicle type's emission class.
const SUMOVTypeParameter & getParameter() const
const std::string & getID() const
Returns the id.
Definition Named.h:74
A storage for options typed value containers)
Definition OptionsCont.h:89
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
void doRegister(const std::string &name, Option *o)
Adds an option under the given name.
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
static OptionsCont & getOptions()
Retrieves the options.
Static storage of an output device and its base (abstract) implementation.
OutputDevice & writeAttr(const SumoXMLAttr attr, const T &val)
writes a named attribute
OutputDevice & openTag(const std::string &xmlElement)
Opens an XML tag.
bool closeTag(const std::string &comment="")
Closes the most recently opened tag and optionally adds a comment.
bool hasParameter(const std::string &key) const
Returns whether the parameter is set.
double getDouble(const std::string &key, const double defaultValue) const
Returns the value for a given key converted to a double.
virtual const std::string getParameter(const std::string &key, const std::string defaultValue="") const
Returns the value for a given key.
static const HelpersEnergy & getEnergyHelper()
get energy helper
static std::string getFuel(const SUMOEmissionClass c)
Returns the fuel type of the given emission class.
static double compute(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const EnergyParams *param)
Returns the amount of the emitted pollutant given the vehicle type and state (in mg/s or ml/s for fue...
Encapsulated SAX-Attributes.
virtual std::string getString(int id, bool *isPresent=nullptr) const =0
Returns the string-value of the named (by its enum-value) attribute.
Representation of a vehicle, person, or container.
virtual bool isVehicle() const
Whether it is a vehicle.
virtual double getAcceleration() const =0
Returns the object's acceleration.
virtual const MSVehicleType & getVehicleType() const =0
Returns the object's "vehicle" type.
std::string getStringParam(const std::string &paramName, const bool required=false, const std::string &deflt="") const
Retrieve a string parameter for the traffic object.
virtual double getSlope() const =0
Returns the slope of the road at object's position in degrees.
virtual const MSLane * getLane() const =0
Returns the lane the object is currently at.
virtual double getSpeed() const =0
Returns the object's current speed.
virtual const SUMOVehicleParameter & getParameter() const =0
Returns the vehicle's parameter (including departure definition)
double getFloatParam(const std::string &paramName, const bool required=false, const double deflt=INVALID_DOUBLE, bool checkDist=true) const
Retrieve a floating point parameter for the traffic object.
virtual double getPositionOnLane() const =0
Get the object's position along the lane.
Structure representing possible vehicle parameter.
bool wasSet(long long int what) const
Returns whether the given parameter was set.
Representation of a vehicle.
Definition SUMOVehicle.h:62
virtual SUMOTime getDeparture() const =0
Returns this vehicle's real departure time.
virtual bool isParking() const =0
Returns the information whether the vehicle is parked.
virtual EnergyParams * getEmissionParameters() const =0
Returns the vehicle's emission model parameter.
virtual double getAngle() const =0
Get the vehicle's angle.
static double toDouble(const std::string &sData)
converts a string into the double value described by it by calling the char-type converter
Definition json.hpp:4471