GenericEngineModel.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// Generic interface for an engine model
/****************************************************************************/
 
#pragma once
#include <config.h>
 
#include <map>
#include <string>
#include <utils/common/SUMOTime.h>
#include <utils/common/Parameterised.h>
 
class GenericEngineModel {
 
public:
    GenericEngineModel() : maxAcceleration_mpsps(1.5), maxDeceleration_mpsps(7) {};
 
    virtual ~GenericEngineModel() {};
 
    virtual double getRealAcceleration(double speed_mps, double accel_mps2, double reqAccel_mps2, SUMOTime timeStep = 0) = 0;
 
    virtual void setParameter(const std::string parameter, const std::string& value) = 0;
    virtual void setParameter(const std::string parameter, double value) = 0;
    virtual void setParameter(const std::string parameter, int value) = 0;
 
    void setMaximumAcceleration(double maxAcc);
    void setMaximumDeceleration(double maxDec);
 
protected:
    //class name, used to log information
    std::string className;
 
    //minimum and maximum acceleration of the model, if any
    double maxAcceleration_mpsps, maxDeceleration_mpsps;
 
    void printParameterError(std::string parameter, std::string value);
 
    void parseParameter(const Parameterised::Map& parameters, std::string parameter, double& value);
    void parseParameter(const Parameterised::Map& parameters, std::string parameter, int& value);
    void parseParameter(const Parameterised::Map& parameters, std::string parameter, std::string& value);
};