EnergyParams.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-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
/****************************************************************************/
// A class for parameters used by the emission models
/****************************************************************************/
#pragma once
#include <config.h>
#include <map>
#include <string>
#include <vector>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/common/ToString.h>
#include <utils/emissions/CharacteristicMap.h>
#include <utils/xml/SUMOXMLDefinitions.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVTypeParameter;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class EnergyParams {
public:
    EnergyParams(const SUMOVTypeParameter* typeParams = nullptr);
 
    EnergyParams(const EnergyParams* secondaryParams) : mySecondaryParams(secondaryParams) {}
 
    ~EnergyParams();
 
    void setSecondary(const EnergyParams* secondaryParams) {
        mySecondaryParams = secondaryParams;
    }
 
    void setDynamicValues(const SUMOTime stopDuration, const bool parking, const SUMOTime waitingTime, const double angle);
 
    void setMass(const double mass);
 
    double getTransportableMass() const {
        return myTransportableMass;
    }
 
    void setTransportableMass(const double mass);
 
    double getTotalMass(const double defaultEmptyMass, const double defaultLoading) const;
 
    double getAngleDiff() const;
 
    double getDouble(SumoXMLAttr attr) const;
 
    double getDoubleOptional(SumoXMLAttr attr, const double def) const;
 
    const CharacteristicMap& getCharacteristicMap(SumoXMLAttr attr) const;
 
    const std::string dump() const {
        return joinToString(myMap, ", ", ":") + (mySecondaryParams ? mySecondaryParams->dump() : "");
    }
 
    bool isEngineOff() const;
 
    bool isOff() const;
 
    static const EnergyParams* getDefault() {
        if (myDefault == nullptr) {
            myDefault = new EnergyParams();
        }
        return myDefault;
    }
 
private:
    std::map<SumoXMLAttr, double> myMap;
    std::map<SumoXMLAttr, CharacteristicMap> myCharacteristicMapMap;
    const EnergyParams* mySecondaryParams = nullptr;
    bool myHaveDefaultMass = false;
    bool myHaveDefaultFrontSurfaceArea = false;
    double myStopDurationSeconds = -1.;
    bool myAmParking = false;
    double myWaitingTimeSeconds = -1.;
    double myLastAngle = INVALID_DOUBLE;
    double myAngle = INVALID_DOUBLE;
    double myTransportableMass = 0.;
 
    static const EnergyParams* myDefault;
    static const std::vector<SumoXMLAttr> myParamAttrs;
 
    EnergyParams(const EnergyParams& s) = delete;
 
    EnergyParams& operator=(const EnergyParams& s) = delete;
};