MSDevice_Battery.h

Go to the documentation of this file.

/****************************************************************************/
// The Battery parameters for the vehicle
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2013-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/

// ===========================================================================
// included modules
// ===========================================================================

#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#ifndef MSDevice_Battery_h
#define MSDevice_Battery_h

#include <microsim/devices/MSDevice.h>
#include <microsim/MSVehicle.h>
#include <microsim/trigger/MSChargingStation.h>
#include <utils/common/SUMOTime.h>


// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;


// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Battery : public MSDevice {
public:
    static void insertOptions(OptionsCont& oc);

    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSDevice*>& into);

public:
    ~MSDevice_Battery();


    bool notifyMove(SUMOVehicle& veh, double oldPos,  double newPos, double newSpeed);

    const std::string deviceName() const {
        return "battery";
    }

    std::string getParameter(const std::string& key) const;

    void setParameter(const std::string& key, const std::string& value);

private:
    MSDevice_Battery(SUMOVehicle& holder, const std::string& id, const double actualBatteryCapacity, const double maximumBatteryCapacity,
                     const double powerMax, const double stoppingTreshold, const std::map<int, double>& param);

    void checkParam(const SumoXMLAttr paramKey, const double lower = 0., const double upper = std::numeric_limits<double>::infinity());

public:
    double getActualBatteryCapacity() const;

    double getMaximumBatteryCapacity() const;

    double getMaximumPower() const;

    bool isChargingStopped() const;

    bool isChargingInTransit() const;

    double getChargingStartTime() const;

    double getConsum() const;

    std::string getChargingStationID() const;

    double getEnergyCharged() const;

    int getVehicleStopped() const;

    double getStoppingTreshold() const;

    void setActualBatteryCapacity(const double actualBatteryCapacity);

    void setMaximumBatteryCapacity(const double maximumBatteryCapacity);

    void setPowerMax(const double new_Pmax);

    void setStoppingTreshold(const double stoppingTreshold);

    void resetChargingStartTime();

    void increaseChargingStartTime();

    void resetVehicleStoppedTimer();

    void increaseVehicleStoppedTimer();

protected:
    double myActualBatteryCapacity;

    double myMaximumBatteryCapacity;

    double myPowerMax;

    double myStoppingTreshold;

    std::map<int, double> myParam;

    double myLastAngle;

    bool myChargingStopped;

    bool myChargingInTransit;

    double myChargingStartTime;

    double myConsum;

    MSChargingStation* myActChargingStation;

    double myEnergyCharged;

    int myVehicleStopped;

private:
    MSDevice_Battery(const MSDevice_Battery&);

    MSDevice_Battery& operator=(const MSDevice_Battery&);
};

#endif