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