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-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
14 // Generic interface for an engine model
15 /****************************************************************************/
16 
17 #ifndef GENERICENGINEMODEL_H_
18 #define GENERICENGINEMODEL_H_
19 
20 #include <map>
21 #include <string>
22 #include <utils/common/SUMOTime.h>
23 
30 
31 public:
32 
33  typedef std::map<std::string, std::string> ParMap;
34 
35 protected:
36 
37  //class name, used to log information
38  std::string className;
39  //minimum and maximum acceleration of the model, if any
41 
45  void printParameterError(std::string parameter, std::string value);
46 
50  void parseParameter(const ParMap& parameters, std::string parameter, double& value);
51  void parseParameter(const ParMap& parameters, std::string parameter, int& value);
52  void parseParameter(const ParMap& parameters, std::string parameter, std::string& value);
53 
54 public:
55 
57  virtual ~GenericEngineModel() {};
58 
71  virtual double getRealAcceleration(double speed_mps, double accel_mps2, double reqAccel_mps2, SUMOTime timeStep = 0) = 0;
72 
80  virtual void loadParameters(const ParMap& parameters) = 0;
81 
88  virtual void setParameter(const std::string parameter, const std::string& value) = 0;
89  virtual void setParameter(const std::string parameter, double value) = 0;
90  virtual void setParameter(const std::string parameter, int value) = 0;
91 
110  double setMaximumAcceleration();
117  double setMaximumDeceleration();
118 
119 };
120 
121 #endif /* GENERICENGINEMODEL_H_ */
GenericEngineModel::~GenericEngineModel
virtual ~GenericEngineModel()
Definition: GenericEngineModel.h:57
GenericEngineModel::setMaximumDeceleration
double setMaximumDeceleration()
Definition: GenericEngineModel.cpp:63
SUMOTime.h
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:34
GenericEngineModel::GenericEngineModel
GenericEngineModel()
Definition: GenericEngineModel.h:56
GenericEngineModel::getRealAcceleration
virtual double getRealAcceleration(double speed_mps, double accel_mps2, double reqAccel_mps2, SUMOTime timeStep=0)=0
GenericEngineModel::setMaximumAcceleration
double setMaximumAcceleration()
Definition: GenericEngineModel.cpp:60
GenericEngineModel::className
std::string className
Definition: GenericEngineModel.h:38
GenericEngineModel::setParameter
virtual void setParameter(const std::string parameter, const std::string &value)=0
GenericEngineModel::maxAcceleration_mpsps
double maxAcceleration_mpsps
Definition: GenericEngineModel.h:40
GenericEngineModel::printParameterError
void printParameterError(std::string parameter, std::string value)
Definition: GenericEngineModel.cpp:24
GenericEngineModel::ParMap
std::map< std::string, std::string > ParMap
Definition: GenericEngineModel.h:33
GenericEngineModel::parseParameter
void parseParameter(const ParMap &parameters, std::string parameter, double &value)
Definition: GenericEngineModel.cpp:28
GenericEngineModel::loadParameters
virtual void loadParameters(const ParMap &parameters)=0
GenericEngineModel
Definition: GenericEngineModel.h:29
GenericEngineModel::maxDeceleration_mpsps
double maxDeceleration_mpsps
Definition: GenericEngineModel.h:40