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-2024 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 }
82}
83
84
85double
86MSDevice_Battery::readParameterValue(SUMOVehicle& v, const SumoXMLAttr& attr, const std::string& paramName, double defaultVal) {
87 const std::string& oldParam = toString(attr);
88 const SUMOVTypeParameter& typeParams = v.getVehicleType().getParameter();
89 if (v.getParameter().hasParameter(oldParam) || typeParams.hasParameter(oldParam)) {
90 WRITE_WARNINGF(TL("Battery device in vehicle '%' still uses old parameter '%'. Please update to 'device.%'."), v.getID(), oldParam, paramName);
91 if (v.getParameter().getParameter(oldParam, "-") == "-") {
92 return typeParams.getDouble(oldParam, defaultVal);
93 }
94 return StringUtils::toDouble(v.getParameter().getParameter(oldParam, "0"));
95 }
96 return v.getFloatParam("device." + paramName, false, defaultVal);
97}
98
99
100// ---------------------------------------------------------------------------
101// MSDevice_Battery-methods
102// ---------------------------------------------------------------------------
103MSDevice_Battery::MSDevice_Battery(SUMOVehicle& holder, const std::string& id, const double actualBatteryCapacity, const double maximumBatteryCapacity,
104 const double stoppingThreshold, const double maximumChargeRate, const std::string& chargeLevelTable, const std::string& chargeCurveTable) :
105 MSVehicleDevice(holder, id),
106 myActualBatteryCapacity(0), // [actualBatteryCapacity <= maximumBatteryCapacity]
107 myMaximumBatteryCapacity(0), // [maximumBatteryCapacity >= 0]
108 myStoppingThreshold(0), // [stoppingThreshold >= 0]
109 myMaximumChargeRate(0),
110 myChargeLimit(-1),
111 myLastAngle(std::numeric_limits<double>::infinity()),
112 myChargingStopped(false), // Initially vehicle don't charge stopped
113 myChargingInTransit(false), // Initially vehicle don't charge in transit
114 myChargingStartTime(0), // Initially charging start time (must be if the vehicle was launched at the charging station)
115 myConsum(0), // Initially the vehicle is stopped and therefore the consum is zero.
116 myTotalConsumption(0.0),
117 myTotalRegenerated(0.0),
118 myActChargingStation(nullptr), // Initially the vehicle isn't over a Charging Station
119 myPreviousNeighbouringChargingStation(nullptr), // Initially the vehicle wasn't over a Charging Station
120 myEnergyCharged(0), // Initially the energy charged is zero
121 myVehicleStopped(0),
122 myDepletedCount(0) {
123 // Initially the vehicle is stopped and the corresponding variable is 0
124
125 if (maximumBatteryCapacity < 0) {
126 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
127 } else {
128 myMaximumBatteryCapacity = maximumBatteryCapacity;
129 }
130
131 if (actualBatteryCapacity > maximumBatteryCapacity) {
132 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' has a % (%) greater than its % (%). A max battery capacity value will be assigned."),
133 getID(), toString(SUMO_ATTR_ACTUALBATTERYCAPACITY), toString(actualBatteryCapacity), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
135 } else {
136 myActualBatteryCapacity = actualBatteryCapacity;
137 }
138
139 if (stoppingThreshold < 0) {
140 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_STOPPINGTHRESHOLD), toString(stoppingThreshold));
141 } else {
142 myStoppingThreshold = stoppingThreshold;
143 }
144
145 myTrackFuel = PollutantsInterface::getFuel(holder.getVehicleType().getEmissionClass()) != "Electricity" && OptionsCont::getOptions().getBool("device.battery.track-fuel");
147 WRITE_WARNINGF(TL("The battery device is active for vehicle '%' but no emission class is set. "
148 "Please consider setting an explicit emission class or battery outputs might be inconsistent with emission outputs!"),
149 holder.getID());
150 }
152
153 if (maximumChargeRate < 0) {
154 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMCHARGERATE), toString(maximumChargeRate));
155 } else {
156 if (!chargeLevelTable.empty() && !chargeCurveTable.empty()) {
157 LinearApproxHelpers::setPoints(myChargeCurve, chargeLevelTable, chargeCurveTable);
159 } else {
160 myMaximumChargeRate = maximumChargeRate;
161 }
162 }
163}
164
165
168
169
170bool MSDevice_Battery::notifyMove(SUMOTrafficObject& tObject, double /* oldPos */, double /* newPos */, double /* newSpeed */) {
171 if (!tObject.isVehicle()) {
172 return false;
173 }
174 SUMOVehicle& veh = static_cast<SUMOVehicle&>(tObject);
175 // Start vehicleStoppedTimer if the vehicle is stopped. In other case reset timer
176 if (veh.getSpeed() < myStoppingThreshold) {
177 // Increase vehicle stopped timer
179 } else {
180 // Reset vehicle Stopped
182 }
183
184 // Update Energy from the battery
186 if (getMaximumBatteryCapacity() != 0) {
188 // no explicit emission class, we fall back to the energy model; a warning has been issued on creation
190 veh.getSlope(), params) * TS;
191 } else {
194 veh.getSpeed(), veh.getAcceleration(),
195 veh.getSlope(), params) * TS;
196 }
197 if (veh.isParking()) {
198 // recuperation from last braking step is ok but further consumption should cease
199 myConsum = MIN2(myConsum, 0.0);
200 }
201
202 // saturate between 0 and myMaximumBatteryCapacity [Wh]
205 if (myDepletedCount == 1) {
206 WRITE_WARNINGF(TL("Battery of vehicle '%' is depleted, time=%."), veh.getID(), time2string(SIMSTEP));
207 }
208 }
209
210 // Energy lost/gained from vehicle movement (via vehicle energy model) [Wh]
212
213 // Track total energy consumption and regeneration
214 if (myConsum > 0.0) {
216 } else {
218 }
219
220 myLastAngle = veh.getAngle();
221 }
222
223 // Check if vehicle has under their position one charge Station
224 const std::string chargingStationID = MSNet::getInstance()->getStoppingPlaceID(veh.getLane(), veh.getPositionOnLane(), SUMO_TAG_CHARGING_STATION);
225
226 // If vehicle is over a charging station
227 if (chargingStationID != "") {
228 // if the vehicle is almost stopped, or charge in transit is enabled, then charge vehicle
230 const MSParkingArea* pa = cs->getParkingArea();
231 if (((veh.getSpeed() < myStoppingThreshold) || cs->getChargeInTransit()) && (pa == nullptr || veh.isParking()) && cs->getChargeType() == myChargeType) {
232 // Set Flags Stopped/intransit to
233 if (veh.getSpeed() < myStoppingThreshold) {
234 // vehicle ist almost stopped, then is charging stopped
235 myChargingStopped = true;
236
237 // therefore isn't charging in transit
238 myChargingInTransit = false;
239 } else {
240 // vehicle is moving, and the Charging station allow charge in transit
241 myChargingStopped = false;
242
243 // Therefore charge in transit
244 myChargingInTransit = true;
245 }
246
247 // get pointer to charging station
249
250 // Only update charging start time if vehicle allow charge in transit, or in other case
251 // if the vehicle not allow charge in transit but it's stopped.
253 // Update Charging start time
255 }
256
257 // time it takes the vehicle at the station < charging station time delay?
259 // Enable charging vehicle
261
262 // Calulate energy charged
264
265 // Update Battery charge
267 }
268 // add charge value for output to myActChargingStation
270 }
271 // else disable charging vehicle
272 else {
273 cs->setChargingVehicle(false);
274 }
275 // 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)
278 }
280 }
281 // In other case, vehicle will be not charged
282 else {
283 // Disable flags
284 myChargingInTransit = false;
285 myChargingStopped = false;
286
287 // Disable charging vehicle
288 if (myActChargingStation != nullptr) {
290 }
291
292 // Set charging station pointer to NULL
293 myActChargingStation = nullptr;
294
295 // Set energy charged to 0
296 myEnergyCharged = 0.00;
297
298 // Reset timer
300 }
301
302 // Always return true.
303 return true;
304}
305
306
307void
311 std::vector<std::string> internals;
312 internals.push_back(toString(myActualBatteryCapacity));
313 internals.push_back(toString(myLastAngle));
314 internals.push_back(toString(myChargingStopped));
315 internals.push_back(toString(myChargingInTransit));
316 internals.push_back(toString(myChargingStartTime));
317 internals.push_back(toString(myTotalConsumption));
318 internals.push_back(toString(myTotalRegenerated));
319 internals.push_back(toString(myEnergyCharged));
320 internals.push_back(toString(myVehicleStopped));
321 internals.push_back(getChargingStationID());
322 std::string prevChargingID = (myPreviousNeighbouringChargingStation == nullptr) ? "NULL" : myPreviousNeighbouringChargingStation->getID();
323 internals.push_back(prevChargingID);
324 internals.push_back(toString(myMaximumChargeRate));
325 out.writeAttr(SUMO_ATTR_STATE, toString(internals));
326 out.closeTag();
327}
328
329
330void
332 std::istringstream bis(attrs.getString(SUMO_ATTR_STATE));
334 bis >> myLastAngle;
335 bis >> myChargingStopped;
336 bis >> myChargingInTransit;
337 bis >> myChargingStartTime;
338 bis >> myTotalConsumption;
339 bis >> myTotalRegenerated;
340 bis >> myEnergyCharged;
341 bis >> myVehicleStopped;
342 std::string chargingID;
343 bis >> chargingID;
344 if (chargingID != "NULL") {
346 }
347 std::string prevChargingID;
348 bis >> prevChargingID;
349 if (prevChargingID != "NULL") {
351 }
352 bis >> myMaximumChargeRate;
353}
354
355
356void
357MSDevice_Battery::setActualBatteryCapacity(const double actualBatteryCapacity) {
358 if (actualBatteryCapacity < 0) {
360 } else if (actualBatteryCapacity > myMaximumBatteryCapacity) {
362 } else {
363 myActualBatteryCapacity = actualBatteryCapacity;
364 }
365}
366
367
368void
369MSDevice_Battery::setMaximumBatteryCapacity(const double maximumBatteryCapacity) {
370 if (myMaximumBatteryCapacity < 0) {
371 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
372 } else {
373 myMaximumBatteryCapacity = maximumBatteryCapacity;
374 }
375}
376
377
378void
379MSDevice_Battery::setStoppingThreshold(const double stoppingThreshold) {
380 if (stoppingThreshold < 0) {
381 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_STOPPINGTHRESHOLD), toString(stoppingThreshold));
382 } else {
383 myStoppingThreshold = stoppingThreshold;
384 }
385}
386
387
388void
390 if (chargeRate < 0) {
391 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMCHARGERATE), toString(chargeRate));
392 } else {
393 myMaximumChargeRate = chargeRate;
394 }
395}
396
397
398void
400 myChargeLimit = limit;
401}
402
403
404void
408
409
410void
414
415
416void
420
421
422void
426
427
428double
432
433
434double
438
439
440double
442 return myConsum;
443}
444
445double
449
450
451double
455
456
457bool
461
462
463bool
467
468
473
474
476MSDevice_Battery::estimateChargingDuration(const double toCharge, const double csPower) const {
477 //if (!myChargeCurve.empty()) {
478 // // TODO: integrate charge curve
479 //}
480 return TIME2STEPS(toCharge / MIN2(csPower, myMaximumChargeRate));
481}
482
483
484std::string
486 if (myActChargingStation != nullptr) {
487 return myActChargingStation->getID();
488 } else {
489 return "NULL";
490 }
491}
492
493double
497
498
499int
503
504
505double
509
510
511double
516
517
518bool
520 return myTrackFuel;
521}
522
523
528
529
530std::string
531MSDevice_Battery::getParameter(const std::string& key) const {
533 || key == toString(SUMO_ATTR_CHARGELEVEL)) {
535 } else if (key == toString(SUMO_ATTR_ENERGYCONSUMED)) {
536 return toString(getConsum());
537 } else if (key == "chargePower") {
538 return toString(getEnergyCharged() * 3600.);
539 } else if (key == "usedAverage") {
541 } else if (key == toString(SUMO_ATTR_TOTALENERGYCONSUMED)) {
543 } else if (key == toString(SUMO_ATTR_TOTALENERGYREGENERATED)) {
545 } else if (key == toString(SUMO_ATTR_ENERGYCHARGED)) {
546 return toString(getEnergyCharged());
547 } else if (key == toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY) || key == "capacity") {
549 } else if (key == toString(SUMO_ATTR_MAXIMUMCHARGERATE)) {
551 } else if (key == toString(SUMO_ATTR_CHARGINGSTATIONID)) {
552 return getChargingStationID();
553 }
554 throw InvalidArgument("Parameter '" + key + "' is not supported for device of type '" + deviceName() + "'");
555}
556
557
558void
559MSDevice_Battery::setParameter(const std::string& key, const std::string& value) {
560 double doubleValue;
561 try {
562 doubleValue = StringUtils::toDouble(value);
563 } catch (NumberFormatException&) {
564 throw InvalidArgument("Setting parameter '" + key + "' requires a number for device of type '" + deviceName() + "'");
565 }
567 setActualBatteryCapacity(doubleValue);
568 } else if (key == toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY) || key == "capacity") {
569 setMaximumBatteryCapacity(doubleValue);
570 } else if (key == toString(SUMO_ATTR_MAXIMUMCHARGERATE)) {
571 setMaximumChargeRate(doubleValue);
572 } else {
573 throw InvalidArgument("Setting parameter '" + key + "' is not supported for device of type '" + deviceName() + "'");
574 }
575}
576
577
578void
580 // @note: only charing is performed but no energy is consumed
582 myConsum = 0;
583}
584
585
586void
588 if (tripinfoOut != nullptr) {
589 tripinfoOut->openTag("battery");
590 tripinfoOut->writeAttr("depleted", toString(myDepletedCount));
591 tripinfoOut->writeAttr("actualBatteryCapacity", toString(myActualBatteryCapacity));
592 tripinfoOut->writeAttr("totalEnergyConsumed", toString(myTotalConsumption));
593 tripinfoOut->writeAttr("totalEnergyRegenerated", toString(myTotalRegenerated));
594 tripinfoOut->closeTag();
595 }
596}
597
598
599/****************************************************************************/
long long int SUMOTime
Definition GUI.h:36
#define DEFAULT_CHARGE_RATIO
#define DEFAULT_MAX_CAPACITY
#define WRITE_WARNINGF(...)
Definition MsgHandler.h:296
#define TL(string)
Definition MsgHandler.h:315
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:69
#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:76
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.
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:155
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:195
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition MSNet.cpp:186
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:1402
MSStoppingPlace * getStoppingPlace(const std::string &id, const SumoXMLTag category) const
Returns the named stopping place of the given category.
Definition MSNet.cpp:1381
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) 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