Eclipse SUMO - Simulation of Urban MObility
EffortCalculator.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 /****************************************************************************/
15 // The EffortCalculator is an interface for additional edge effort calculators
16 /****************************************************************************/
17 #ifndef EffortCalculator_h
18 #define EffortCalculator_h
19 
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 #include <config.h>
25 
27 
28 
29 // ===========================================================================
30 // class definitions
31 // ===========================================================================
34 
35 public:
36 
38  virtual void init(const std::vector<std::string>& edges) = 0;
39 
41  virtual void addStop(const int stopEdge, const Parameterised& params) = 0;
42 
44  virtual double getEffort(const int numericalID) const = 0;
45 
47  virtual void update(const int edge, const int prev, const double length) = 0;
48 
50  virtual void setInitialState(const int edge) = 0;
51 
53  virtual std::string output(const int edge) const = 0;
54 
55 };
56 
57 
58 #endif
59 
60 /****************************************************************************/
virtual void init(const std::vector< std::string > &edges)=0
the effort calculator interface
virtual void update(const int edge, const int prev, const double length)=0
virtual void addStop(const int stopEdge, const Parameterised &params)=0
An upper class for objects with additional parameters.
Definition: Parameterised.h:43
virtual std::string output(const int edge) const =0
virtual void setInitialState(const int edge)=0
virtual double getEffort(const int numericalID) const =0