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-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 // The EffortCalculator is an interface for additional edge effort calculators
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 
24 
25 
26 // ===========================================================================
27 // class definitions
28 // ===========================================================================
31 
32 public:
33 
35  virtual void init(const std::vector<std::string>& edges) = 0;
36 
38  virtual void addStop(const int stopEdge, const Parameterised& params) = 0;
39 
41  virtual double getEffort(const int numericalID) const = 0;
42 
44  virtual void update(const int edge, const int prev, const double length) = 0;
45 
47  virtual void setInitialState(const int edge) = 0;
48 
50  virtual std::string output(const int edge) const = 0;
51 
52 };
the effort calculator interface
virtual double getEffort(const int numericalID) const =0
virtual std::string output(const int edge) const =0
virtual void setInitialState(const int edge)=0
virtual void init(const std::vector< std::string > &edges)=0
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:39