Eclipse SUMO - Simulation of Urban MObility
GenericEngineModel.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2020 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
18 // Generic interface for an engine model
19 /****************************************************************************/
20 
21 #pragma once
22 
23 #include <map>
24 #include <string>
25 #include <utils/common/SUMOTime.h>
26 
33 
34 public:
35 
36  typedef std::map<std::string, std::string> ParMap;
37 
38 protected:
39 
40  //class name, used to log information
41  std::string className;
42  //minimum and maximum acceleration of the model, if any
44 
48  void printParameterError(std::string parameter, std::string value);
49 
53  void parseParameter(const ParMap& parameters, std::string parameter, double& value);
54  void parseParameter(const ParMap& parameters, std::string parameter, int& value);
55  void parseParameter(const ParMap& parameters, std::string parameter, std::string& value);
56 
57 public:
58 
60  virtual ~GenericEngineModel() {};
61 
74  virtual double getRealAcceleration(double speed_mps, double accel_mps2, double reqAccel_mps2, SUMOTime timeStep = 0) = 0;
75 
83  virtual void loadParameters(const ParMap& parameters) = 0;
84 
91  virtual void setParameter(const std::string parameter, const std::string& value) = 0;
92  virtual void setParameter(const std::string parameter, double value) = 0;
93  virtual void setParameter(const std::string parameter, int value) = 0;
94 
113  double setMaximumAcceleration();
120  double setMaximumDeceleration();
121 
122 };
123 
long long int SUMOTime
Definition: SUMOTime.h:31
std::map< std::string, std::string > ParMap
void parseParameter(const ParMap &parameters, std::string parameter, double &value)
virtual void setParameter(const std::string parameter, int value)=0
virtual double getRealAcceleration(double speed_mps, double accel_mps2, double reqAccel_mps2, SUMOTime timeStep=0)=0
void printParameterError(std::string parameter, std::string value)
virtual void setParameter(const std::string parameter, double value)=0
virtual void setParameter(const std::string parameter, const std::string &value)=0
virtual void loadParameters(const ParMap &parameters)=0