MSDevice_Battery.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2013-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// The Battery parameters for the vehicle
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <microsim/devices/MSVehicleDevice.h>
#include <microsim/MSVehicle.h>
#include <microsim/trigger/MSChargingStation.h>
#include <utils/common/LinearApproxHelpers.h>
#include <utils/common/SUMOTime.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;
class MSDevice_Emissions;
class MSDevice_StationFinder;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Battery : public MSVehicleDevice {
public:
 
    static void insertOptions(OptionsCont& oc);
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into, MSDevice_StationFinder* sf);
 
public:
    ~MSDevice_Battery();
 
 
    bool notifyMove(SUMOTrafficObject& veh, double oldPos,  double newPos, double newSpeed) override;
 
    const std::string deviceName() const override {
        return "battery";
    }
 
    void saveState(OutputDevice& out) const override;
 
    void loadState(const SUMOSAXAttributes& attrs) override;
 
    std::string getParameter(const std::string& key) const override;
 
    void setParameter(const std::string& key, const std::string& value) override;
 
    void notifyParking() override;
 
    void generateOutput(OutputDevice* tripinfoOut) const override;
 
private:
    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);
 
public:
    double getActualBatteryCapacity() const;
 
    double getMaximumBatteryCapacity() const;
 
    double getMaximumPower() const;
 
    bool isChargingStopped() const;
 
    bool isChargingInTransit() const;
 
    SUMOTime getChargingStartTime() const;
 
    SUMOTime estimateChargingDuration(const double toCharge, const double csPower) const;
 
    double getConsum() const;
 
    double getTotalConsumption() const;
 
    double getTotalRegenerated() const;
 
    std::string getChargingStationID() const;
 
    double getEnergyCharged() const;
 
    int getVehicleStopped() const;
 
    double getStoppingThreshold() const;
 
    double getMaximumChargeRate() const;
 
    bool tracksFuel() const;
 
    MSChargingStation::ChargeType getChargeType() const;
 
    void setActualBatteryCapacity(const double actualBatteryCapacity);
 
    void setMaximumBatteryCapacity(const double maximumBatteryCapacity);
 
    void setStoppingThreshold(const double stoppingThreshold);
 
    void setMaximumChargeRate(const double chargeRate);
 
    void setChargeLimit(const double limit);
 
    void resetChargingStartTime();
 
    void increaseChargingStartTime();
 
    void resetVehicleStoppedTimer();
 
    void increaseVehicleStoppedTimer();
 
protected:
    static double readParameterValue(SUMOVehicle& v, const SumoXMLAttr& attr, const std::string& paramName, double defaultVal);
 
    double myActualBatteryCapacity;
 
    double myMaximumBatteryCapacity;
 
    double myStoppingThreshold;
 
    double myMaximumChargeRate;
 
    double myChargeLimit;
 
    double myLastAngle;
 
    bool myChargingStopped;
 
    bool myChargingInTransit;
 
    SUMOTime myChargingStartTime;
 
    double myConsum;
 
    double myTotalConsumption;
 
    double myTotalRegenerated;
 
    LinearApproxHelpers::LinearApproxMap myChargeCurve;
 
    MSChargingStation* myActChargingStation;
 
    MSChargingStation* myPreviousNeighbouringChargingStation;
 
    double myEnergyCharged;
 
    int myVehicleStopped;
 
    int myDepletedCount;
 
    bool myTrackFuel;
 
    MSChargingStation::ChargeType myChargeType;
 
 
private:
    MSDevice_Battery(const MSDevice_Battery&);
 
    MSDevice_Battery& operator=(const MSDevice_Battery&);
};