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 <algorithm>
23
24#include <config.h>
25
33#include <microsim/MSNet.h>
34#include <microsim/MSLane.h>
35#include <microsim/MSEdge.h>
36#include <microsim/MSVehicle.h>
38#include "MSDevice_Emissions.h"
39#include "MSDevice_Battery.h"
40
41#define DEFAULT_MAX_CAPACITY 35000
42#define DEFAULT_CHARGE_RATIO 0.5
43
44
45// ===========================================================================
46// method definitions
47// ===========================================================================
48// ---------------------------------------------------------------------------
49// static initialisation methods
50// ---------------------------------------------------------------------------
51void
53 insertDefaultAssignmentOptions("battery", "Battery", oc);
54 // custom options
55 oc.doRegister("device.battery.track-fuel", new Option_Bool(false));
56 oc.addDescription("device.battery.track-fuel", "Battery", TL("Track fuel consumption for non-electric vehicles"));
57}
58
59
60void
61MSDevice_Battery::buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into, MSDevice_StationFinder* sf) {
62 // Check if vehicle should get a battery
63 if (sf != nullptr || equippedByDefaultAssignmentOptions(OptionsCont::getOptions(), "battery", v, false)) {
64 // obtain parameter values
65 const double maximumBatteryCapacity = readParameterValue(v, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, "battery.capacity", DEFAULT_MAX_CAPACITY);
66 const double actualBatteryCapacity = readParameterValue(v, SUMO_ATTR_ACTUALBATTERYCAPACITY, "battery.chargeLevel", maximumBatteryCapacity * DEFAULT_CHARGE_RATIO);
67 const double stoppingThreshold = readParameterValue(v, SUMO_ATTR_STOPPINGTHRESHOLD, "battery.stoppingThreshold", 0.1);
68 const double maximumChargeRate = readParameterValue(v, SUMO_ATTR_MAXIMUMCHARGERATE, "battery.maximumChargeRate", 150000.);
69 const std::string chargeLevelTable = v.getStringParam("device.battery.chargeLevelTable");
70 const std::string chargeCurveTable = v.getStringParam("device.battery.chargeCurveTable");
71
72 // battery constructor
73 MSDevice_Battery* device = new MSDevice_Battery(v, "battery_" + v.getID(),
74 actualBatteryCapacity, maximumBatteryCapacity, stoppingThreshold, maximumChargeRate, chargeLevelTable, chargeCurveTable);
75
76 // Add device to vehicle
77 into.push_back(device);
78
79 if (sf != nullptr) {
80 sf->setBattery(device);
81 }
82 }
83}
84
85
86double
87MSDevice_Battery::readParameterValue(SUMOVehicle& v, const SumoXMLAttr& attr, const std::string& paramName, double defaultVal) {
88 const std::string& oldParam = toString(attr);
89 const SUMOVTypeParameter& typeParams = v.getVehicleType().getParameter();
90 if (v.getParameter().hasParameter(oldParam) || typeParams.hasParameter(oldParam)) {
91 WRITE_WARNINGF(TL("Battery device in vehicle '%' still uses old parameter '%'. Please update to 'device.%'."), v.getID(), oldParam, paramName);
92 if (v.getParameter().getParameter(oldParam, "-") == "-") {
93 return typeParams.getDouble(oldParam, defaultVal);
94 }
95 return StringUtils::toDouble(v.getParameter().getParameter(oldParam, "0"));
96 }
97 return v.getFloatParam("device." + paramName, false, defaultVal);
98}
99
100
101// ---------------------------------------------------------------------------
102// MSDevice_Battery-methods
103// ---------------------------------------------------------------------------
104MSDevice_Battery::MSDevice_Battery(SUMOVehicle& holder, const std::string& id, const double actualBatteryCapacity, const double maximumBatteryCapacity,
105 const double stoppingThreshold, const double maximumChargeRate, const std::string& chargeLevelTable, const std::string& chargeCurveTable) :
106 MSVehicleDevice(holder, id),
107 myActualBatteryCapacity(0), // [actualBatteryCapacity <= maximumBatteryCapacity]
108 myMaximumBatteryCapacity(0), // [maximumBatteryCapacity >= 0]
109 myStoppingThreshold(0), // [stoppingThreshold >= 0]
110 myMaximumChargeRate(0),
111 myChargeLimit(-1),
112 myLastAngle(std::numeric_limits<double>::infinity()),
113 myChargingStopped(false), // Initially vehicle don't charge stopped
114 myChargingInTransit(false), // Initially vehicle don't charge in transit
115 myChargingStartTime(0), // Initially charging start time (must be if the vehicle was launched at the charging station)
116 myConsum(0), // Initially the vehicle is stopped and therefore the consum is zero.
117 myTotalConsumption(0.0),
118 myTotalRegenerated(0.0),
119 myActChargingStation(nullptr), // Initially the vehicle isn't over a Charging Station
120 myPreviousNeighbouringChargingStation(nullptr), // Initially the vehicle wasn't over a Charging Station
121 myEnergyCharged(0), // Initially the energy charged is zero
122 myVehicleStopped(0),
123 myDepletedCount(0) {
124 // Initially the vehicle is stopped and the corresponding variable is 0
125
126 if (maximumBatteryCapacity < 0) {
127 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
128 } else {
129 myMaximumBatteryCapacity = maximumBatteryCapacity;
130 }
131
132 if (actualBatteryCapacity > maximumBatteryCapacity) {
133 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' has a % (%) greater than its % (%). A max battery capacity value will be assigned."),
134 getID(), toString(SUMO_ATTR_ACTUALBATTERYCAPACITY), toString(actualBatteryCapacity), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
136 } else {
137 myActualBatteryCapacity = actualBatteryCapacity;
138 }
139
140 if (stoppingThreshold < 0) {
141 WRITE_WARNINGF(TL("Battery builder: Vehicle '%' doesn't have a valid value for parameter % (%)."), getID(), toString(SUMO_ATTR_STOPPINGTHRESHOLD), toString(stoppingThreshold));
142 } else {
143 myStoppingThreshold = stoppingThreshold;
144 }
145
146 myTrackFuel = PollutantsInterface::getFuel(holder.getVehicleType().getEmissionClass()) != "Electricity" && OptionsCont::getOptions().getBool("device.battery.track-fuel");
148 WRITE_WARNINGF(TL("The battery device is active for vehicle '%' but no emission class is set. "
149 "Please consider setting an explicit emission class or battery outputs might be inconsistent with emission outputs!"),
150 holder.getID());
151 }
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);
158 if (!myTrackFuel) {
160 }
162 } else {
163 myMaximumChargeRate = maximumChargeRate;
164 if (!myTrackFuel) {
165 myMaximumChargeRate /= 3600.;
166 }
167 }
168 }
169}
170
171
174
175
176bool MSDevice_Battery::notifyMove(SUMOTrafficObject& tObject, double /* oldPos */, double /* newPos */, double /* newSpeed */) {
177 if (!tObject.isVehicle()) {
178 return false;
179 }
180 SUMOVehicle& veh = static_cast<SUMOVehicle&>(tObject);
181 // Start vehicleStoppedTimer if the vehicle is stopped. In other case reset timer
182 if (veh.getSpeed() < myStoppingThreshold) {
183 // Increase vehicle stopped timer
185 } else {
186 // Reset vehicle Stopped
188 }
189
190 // Update Energy from the battery
192 if (getMaximumBatteryCapacity() != 0) {
193 params->setDouble(SUMO_ATTR_ANGLE, myLastAngle == std::numeric_limits<double>::infinity() ? 0. : GeomHelper::angleDiff(myLastAngle, veh.getAngle()));
195 // no explicit emission class, we fall back to the energy model; a warning has been issued on creation
197 veh.getSlope(), params) * TS;
198 } else {
201 veh.getSpeed(), veh.getAcceleration(),
202 veh.getSlope(), params) * TS;
203 }
204 if (veh.isParking()) {
205 // recuperation from last braking step is ok but further consumption should cease
206 myConsum = MIN2(myConsum, 0.0);
207 }
208
209 // saturate between 0 and myMaximumBatteryCapacity [Wh]
212 if (myDepletedCount == 1) {
213 WRITE_WARNINGF(TL("Battery of vehicle '%' is depleted, time=%."), veh.getID(), time2string(SIMSTEP));
214 }
215 }
216
217 // Energy lost/gained from vehicle movement (via vehicle energy model) [Wh]
219
220 // Track total energy consumption and regeneration
221 if (myConsum > 0.0) {
223 } else {
225 }
226
227 myLastAngle = veh.getAngle();
228 }
229
230 // Check if vehicle has under their position one charge Station
231 const std::string chargingStationID = MSNet::getInstance()->getStoppingPlaceID(veh.getLane(), veh.getPositionOnLane(), SUMO_TAG_CHARGING_STATION);
232
233 // If vehicle is over a charging station
234 if (chargingStationID != "") {
235 // if the vehicle is almost stopped, or charge in transit is enabled, then charge vehicle
237 const MSParkingArea* pa = cs->getParkingArea();
238 if (((veh.getSpeed() < myStoppingThreshold) || cs->getChargeInTransit()) && (pa == nullptr || veh.isParking())) {
239 // Set Flags Stopped/intransit to
240 if (veh.getSpeed() < myStoppingThreshold) {
241 // vehicle ist almost stopped, then is charging stopped
242 myChargingStopped = true;
243
244 // therefore isn't charging in transit
245 myChargingInTransit = false;
246 } else {
247 // vehicle is moving, and the Charging station allow charge in transit
248 myChargingStopped = false;
249
250 // Therefore charge in transit
251 myChargingInTransit = true;
252 }
253
254 // get pointer to charging station
256
257 // Only update charging start time if vehicle allow charge in transit, or in other case
258 // if the vehicle not allow charge in transit but it's stopped.
260 // Update Charging start time
262 }
263
264 // time it takes the vehicle at the station < charging station time delay?
266 // Enable charging vehicle
268
269 // Calulate energy charged
271
272 // Update Battery charge
274 }
275 // add charge value for output to myActChargingStation
277 }
278 // else disable charging vehicle
279 else {
280 cs->setChargingVehicle(false);
281 }
282 // 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)
285 }
287 }
288 // In other case, vehicle will be not charged
289 else {
290 // Disable flags
291 myChargingInTransit = false;
292 myChargingStopped = false;
293
294 // Disable charging vehicle
295 if (myActChargingStation != nullptr) {
297 }
298
299 // Set charging station pointer to NULL
300 myActChargingStation = nullptr;
301
302 // Set energy charged to 0
303 myEnergyCharged = 0.00;
304
305 // Reset timer
307 }
308
309 // Always return true.
310 return true;
311}
312
313
314void
318 std::vector<std::string> internals;
319 internals.push_back(toString(myActualBatteryCapacity));
320 internals.push_back(toString(myLastAngle));
321 internals.push_back(toString(myChargingStopped));
322 internals.push_back(toString(myChargingInTransit));
323 internals.push_back(toString(myChargingStartTime));
324 internals.push_back(toString(myTotalConsumption));
325 internals.push_back(toString(myTotalRegenerated));
326 internals.push_back(toString(myEnergyCharged));
327 internals.push_back(toString(myVehicleStopped));
328 internals.push_back(getChargingStationID());
329 std::string prevChargingID = (myPreviousNeighbouringChargingStation == nullptr) ? "NULL" : myPreviousNeighbouringChargingStation->getID();
330 internals.push_back(prevChargingID);
331 internals.push_back(toString(myMaximumChargeRate));
332 out.writeAttr(SUMO_ATTR_STATE, toString(internals));
333 out.closeTag();
334}
335
336
337void
339 std::istringstream bis(attrs.getString(SUMO_ATTR_STATE));
341 bis >> myLastAngle;
342 bis >> myChargingStopped;
343 bis >> myChargingInTransit;
344 bis >> myChargingStartTime;
345 bis >> myTotalConsumption;
346 bis >> myTotalRegenerated;
347 bis >> myEnergyCharged;
348 bis >> myVehicleStopped;
349 std::string chargingID;
350 bis >> chargingID;
351 if (chargingID != "NULL") {
353 }
354 std::string prevChargingID;
355 bis >> prevChargingID;
356 if (prevChargingID != "NULL") {
358 }
359 bis >> myMaximumChargeRate;
360}
361
362
363void
364MSDevice_Battery::setActualBatteryCapacity(const double actualBatteryCapacity) {
365 if (actualBatteryCapacity < 0) {
367 } else if (actualBatteryCapacity > myMaximumBatteryCapacity) {
369 } else {
370 myActualBatteryCapacity = actualBatteryCapacity;
371 }
372}
373
374
375void
376MSDevice_Battery::setMaximumBatteryCapacity(const double maximumBatteryCapacity) {
377 if (myMaximumBatteryCapacity < 0) {
378 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY), toString(maximumBatteryCapacity));
379 } else {
380 myMaximumBatteryCapacity = maximumBatteryCapacity;
381 }
382}
383
384
385void
386MSDevice_Battery::setStoppingThreshold(const double stoppingThreshold) {
387 if (stoppingThreshold < 0) {
388 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_STOPPINGTHRESHOLD), toString(stoppingThreshold));
389 } else {
390 myStoppingThreshold = stoppingThreshold;
391 }
392}
393
394
395void
397 if (chargeRate < 0) {
398 WRITE_WARNINGF(TL("Trying to set into the battery device of vehicle '%' an invalid % (%)."), getID(), toString(SUMO_ATTR_MAXIMUMCHARGERATE), toString(chargeRate));
399 } else {
400 myMaximumChargeRate = chargeRate;
401 }
402}
403
404
405void
407 myChargeLimit = limit;
408}
409
410
411void
415
416
417void
421
422
423void
427
428
429void
433
434
435double
439
440
441double
445
446
447double
449 return myConsum;
450}
451
452double
456
457
458double
462
463
464bool
468
469
470bool
474
475
480
481
483MSDevice_Battery::estimateChargingDuration(const double toCharge, const double csPower) const {
484 //if (!myChargeCurve.empty()) {
485 // // TODO: integrate charge curve
486 //}
487 return TIME2STEPS(toCharge / MIN2(csPower, myMaximumChargeRate));
488}
489
490
491std::string
493 if (myActChargingStation != nullptr) {
494 return myActChargingStation->getID();
495 } else {
496 return "NULL";
497 }
498}
499
500double
504
505
506int
510
511
512double
516
517
518double
523
524
525std::string
526MSDevice_Battery::getParameter(const std::string& key) const {
528 || key == toString(SUMO_ATTR_CHARGELEVEL)) {
530 } else if (key == toString(SUMO_ATTR_ENERGYCONSUMED)) {
531 return toString(getConsum());
532 } else if (key == toString(SUMO_ATTR_TOTALENERGYCONSUMED)) {
534 } else if (key == toString(SUMO_ATTR_TOTALENERGYREGENERATED)) {
536 } else if (key == toString(SUMO_ATTR_ENERGYCHARGED)) {
537 return toString(getEnergyCharged());
538 } else if (key == toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY) || key == "capacity") {
540 } else if (key == toString(SUMO_ATTR_MAXIMUMCHARGERATE)) {
542 } else if (key == toString(SUMO_ATTR_CHARGINGSTATIONID)) {
543 return getChargingStationID();
544 } else if (key == toString(SUMO_ATTR_VEHICLEMASS)) {
545 WRITE_WARNING(TL("Getting the vehicle mass via parameters is deprecated, please use getMass for the vehicle or its type."));
547 }
548 throw InvalidArgument("Parameter '" + key + "' is not supported for device of type '" + deviceName() + "'");
549}
550
551
552void
553MSDevice_Battery::setParameter(const std::string& key, const std::string& value) {
554 double doubleValue;
555 try {
556 doubleValue = StringUtils::toDouble(value);
557 } catch (NumberFormatException&) {
558 throw InvalidArgument("Setting parameter '" + key + "' requires a number for device of type '" + deviceName() + "'");
559 }
561 setActualBatteryCapacity(doubleValue);
562 } else if (key == toString(SUMO_ATTR_MAXIMUMBATTERYCAPACITY) || key == "capacity") {
563 setMaximumBatteryCapacity(doubleValue);
564 } else if (key == toString(SUMO_ATTR_MAXIMUMCHARGERATE)) {
565 setMaximumChargeRate(doubleValue);
566 } else if (key == toString(SUMO_ATTR_VEHICLEMASS)) {
567 WRITE_WARNING(TL("Setting the vehicle mass via parameters is deprecated, please use setMass for the vehicle or its type."));
569 } else {
570 throw InvalidArgument("Setting parameter '" + key + "' is not supported for device of type '" + deviceName() + "'");
571 }
572}
573
574
575void
577 // @note: only charing is performed but no energy is consumed
579 myConsum = 0;
580}
581
582
583void
585 if (tripinfoOut != nullptr) {
586 tripinfoOut->openTag("battery");
587 tripinfoOut->writeAttr("depleted", toString(myDepletedCount));
588 tripinfoOut->closeTag();
589 }
590}
591
592
593/****************************************************************************/
long long int SUMOTime
Definition GUI.h:36
#define DEFAULT_CHARGE_RATIO
#define DEFAULT_MAX_CAPACITY
#define WRITE_WARNINGF(...)
Definition MsgHandler.h:296
#define WRITE_WARNING(msg)
Definition MsgHandler.h:295
#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 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_MASS
@ SUMO_ATTR_MAXIMUMCHARGERATE
Maximum Power.
@ SUMO_ATTR_STOPPINGTHRESHOLD
Stopping threshold.
@ SUMO_ATTR_CHARGINGSTATIONID
Charging Station ID.
@ SUMO_ATTR_ANGLE
@ SUMO_ATTR_ACTUALBATTERYCAPACITY
@ SUMO_ATTR_VEHICLEMASS
Vehicle mass.
@ 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 getDouble(SumoXMLAttr attr) const
void setDouble(SumoXMLAttr attr, double value)
Sets a parameter.
static double angleDiff(const double angle1, const double angle2)
Returns the difference of the second angle to the first angle in radiants.
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 void scaleValues(LinearApproxMap &map, const double factor)
Scale values.
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.
const MSParkingArea * getParkingArea() const
Get the parking area the charging station is placed on.
Battery device for electric vehicles.
SUMOTime getChargingStartTime() const
Get charging start time.
static void insertOptions(OptionsCont &oc)
Inserts MSDevice_Example-options.
void notifyParking()
called to update state for parking vehicles
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.
double myActualBatteryCapacity
Parameter, The actual vehicles's Battery Capacity in Wh, [myActualBatteryCapacity <= myMaximumBattery...
bool notifyMove(SUMOTrafficObject &veh, double oldPos, double newPos, double newSpeed)
Checks for waiting steps when the vehicle moves.
double getMaximumChargeRate() const
Get current charge rate in W depending on the state of charge.
void saveState(OutputDevice &out) const
Saves the state of the device.
void increaseChargingStartTime()
Increase Charging Start time.
MSChargingStation * myPreviousNeighbouringChargingStation
Parameter, Pointer to charging station neighbouring with myActChargingStation in which vehicle was pl...
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.
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, wich the vehicle has beging to charging.
bool isChargingInTransit() const
Get true if Vehicle it's charging, false if not.
std::string getParameter(const std::string &key) const
try to retrieve the given parameter from this device. Throw exception for unsupported key
void resetChargingStartTime()
Reset charging start time.
double myTotalConsumption
Parameter, total vehicle energy consumption.
const std::string deviceName() const
return the name for this type of device
void resetVehicleStoppedTimer()
Reset myVehicleStopped.
void loadState(const SUMOSAXAttributes &attrs)
Loads the state of the device from the given description.
void setParameter(const std::string &key, const std::string &value)
try to set the given parameter for this device. Throw exception for unsupported key
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)
void generateOutput(OutputDevice *tripinfoOut) const
Called on vehicle deletion to extend tripinfo.
~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:185
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:1401
MSStoppingPlace * getStoppingPlace(const std::string &id, const SumoXMLTag category) const
Returns the named stopping place of the given category.
Definition MSNet.cpp:1380
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 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