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-2015 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>
#include <iostream>
#include <sstream>
#include <string>


// ===========================================================================
// 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, SUMOReal oldPos,
                    SUMOReal newPos, SUMOReal newSpeed);


    bool notifyEnter(SUMOVehicle& veh, MSMoveReminder::Notification reason);



    void generateOutput() const;


private:
    MSDevice_Battery(SUMOVehicle& holder, const std::string& id, const SUMOReal new_ActBatKap, const SUMOReal new_MaxBatKap, const SUMOReal new_PowerMax, const SUMOReal new_Mass, const SUMOReal new_FrontSurfaceArea, const SUMOReal new_AirDragCoefficient, const SUMOReal new_InternalMomentOfInertia, const SUMOReal new_RadialDragCoefficient, const SUMOReal new_RollDragCoefficient, const SUMOReal new_ConstantPowerIntake, const SUMOReal new_PropulsionEfficiency, const SUMOReal new_RecuperationEfficiency, const SUMOReal new_LastAngle, const SUMOReal new_LastEnergy);


public:
    // GET FUNCTIONS

    SUMOReal getActualBatteryCapacity() const;

    SUMOReal getMaximumBatteryCapacity() const;

    inline SUMOReal getMaximumPower() const;

    inline SUMOReal getMass() const;

    inline SUMOReal getFrontSurfaceArea() const;

    inline SUMOReal getAirDragCoefficient() const;

    inline SUMOReal getInternalMomentOfInertia() const;

    inline SUMOReal getRadialDragCoefficient() const;

    inline SUMOReal getRollDragCoefficient() const;

    inline SUMOReal getConstantPowerIntake() const;

    inline SUMOReal getPropulsionEfficiency() const;

    inline SUMOReal getRecuperationEfficiency() const;

    inline SUMOReal getLastAngle() const;

    inline SUMOReal getLastEnergy() const;

    bool isChargingStopped() const;

    bool isChargingInTransit() const;

    inline SUMOReal getChargingStartTime() const;

    SUMOReal getConsum() const;

    const std::string& getChargingStationID() const;

    SUMOReal getChrgEnergy() const;

    int getVehicleStopped() const;

    SUMOReal getPropEnergy(SUMOVehicle& veh);


    // SET FUNCTIONS

    inline void setActualBatteryCapacity(const SUMOReal new_ActBatKap);

    inline void setMaximumBatteryCapacity(const SUMOReal new_MaxBatKap);

    inline void setPowerMax(const SUMOReal new_Pmax);

    inline void setMass(const SUMOReal new_Mass);

    inline void setFrontSurfaceArea(const SUMOReal new_FrontSurfaceArea);

    inline void setAirDragCoefficient(const SUMOReal new_C_Veh);

    inline void setInternalMomentOfInertia(const SUMOReal new_InternalMomentOfInertia);

    inline void setRadialDragCoefficient(const SUMOReal new_RadialDragCoefficient);

    inline void setRollDragCoefficient(const SUMOReal new_RollDragCoefficient);

    inline void setConstantPowerIntake(const SUMOReal new_ConstantPowerIntake);

    inline void setPropulsionEfficiency(const SUMOReal new_PropulsionEfficiency);

    inline void setRecuperationEfficiency(const SUMOReal new_RecuperationEfficiency);

    inline void setLastAngle(const SUMOReal new_LastAngle);

    inline void setLastEnergy(const SUMOReal new_LastEnergy);

    inline void resetChargingStartTime();

    inline void increaseChargingStartTime();

    inline void resetVehicleStoppedTimer();

    inline void increaseVehicleStoppedTimer();

private:

    SUMOReal ActBatKap;

    SUMOReal MaxBatKap;

    SUMOReal PowerMax;

    SUMOReal Mass;

    SUMOReal FrontSurfaceArea;

    SUMOReal AirDragCoefficient;

    SUMOReal InternalMomentOfInertia;

    SUMOReal RadialDragCoefficient;

    SUMOReal RollDragCoefficient;

    SUMOReal ConstantPowerIntake;

    SUMOReal PropulsionEfficiency;

    SUMOReal RecuperationEfficiency;

    SUMOReal LastAngle;

    SUMOReal LastEnergy;

    bool ItsChargingStopped;

    bool ItsChargingInTransit;

    SUMOReal ChargingStartTime;

    SUMOReal Consum;

    std::string actChargingStation;

    SUMOReal energyCharged;

    int vehicleStopped;


    std::string SUMOReal_str(const SUMOReal& var);


    MSDevice_Battery(const MSDevice_Battery&);


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

#endif