Eclipse SUMO - Simulation of Urban MObility
Edge.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2017-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 // C++ TraCI client API implementation
15 /****************************************************************************/
16 
17 #ifndef SUMO_Edge_H
18 #define SUMO_Edge_H
19 
20 // ===========================================================================
21 // included modules
22 // ===========================================================================
23 #include <config.h>
24 
25 #include <string>
26 #include <vector>
27 #include <memory>
28 #include <libsumo/TraCIDefs.h>
29 #include <libsumo/TraCIConstants.h>
30 
31 
32 // ===========================================================================
33 // class declarations
34 // ===========================================================================
35 class MSEdge;
36 class PositionVector;
37 namespace libsumo {
38 class VariableWrapper;
39 }
40 
41 
42 // ===========================================================================
43 // class definitions
44 // ===========================================================================
49 namespace libsumo {
50 
51 class Edge {
52 public:
53  static std::vector<std::string> getIDList();
54  static int getIDCount();
55  static double getAdaptedTraveltime(const std::string& id, double time);
56  static double getEffort(const std::string& id, double time);
57  static double getTraveltime(const std::string& id);
58  static double getWaitingTime(const std::string& id);
59  static const std::vector<std::string> getLastStepPersonIDs(const std::string& id);
60  static const std::vector<std::string> getLastStepVehicleIDs(const std::string& id);
61  static double getCO2Emission(const std::string& id);
62  static double getCOEmission(const std::string& id);
63  static double getHCEmission(const std::string& id);
64  static double getPMxEmission(const std::string& id);
65  static double getNOxEmission(const std::string& id);
66  static double getFuelConsumption(const std::string& id);
67  static double getNoiseEmission(const std::string& id);
68  static double getElectricityConsumption(const std::string& id);
69  static int getLastStepVehicleNumber(const std::string& id);
70  static double getLastStepMeanSpeed(const std::string& id);
71  static double getLastStepOccupancy(const std::string& id);
72  static int getLastStepHaltingNumber(const std::string& id);
73  static double getLastStepLength(const std::string& id);
74  static int getLaneNumber(const std::string& id);
75  static std::string getStreetName(const std::string& id);
76  static std::string getParameter(const std::string& id, const std::string& paramName);
77  static void setAllowedVehicleClasses(const std::string& id, std::vector<std::string> vector);
78  static void setDisallowedVehicleClasses(const std::string& id, std::vector<std::string> classes);
79  static void setAllowedSVCPermissions(const std::string& id, int permissions);
80  static void adaptTraveltime(const std::string& id, double value, double begTime = 0., double endTime = std::numeric_limits<double>::max());
81  static void setEffort(const std::string& id, double value, double begTime = 0., double endTime = std::numeric_limits<double>::max());
82  static void setMaxSpeed(const std::string& id, double value);
83  static void setParameter(const std::string& id, const std::string& name, const std::string& value);
84 
86 
91  static void storeShape(const std::string& id, PositionVector& shape);
92 
93  static std::shared_ptr<VariableWrapper> makeWrapper();
94 
95  static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper);
96 
97 private:
98  static MSEdge* getEdge(const std::string& id);
99 
100 private:
103 
104 private:
106  Edge() = delete;
107 
108 };
109 
110 }
111 
112 
113 #endif //SUMO_Edge_H
114 
115 /****************************************************************************/
libsumo::Edge::getLastStepHaltingNumber
static int getLastStepHaltingNumber(const std::string &id)
Definition: Edge.cpp:239
libsumo::Edge::getEdge
static MSEdge * getEdge(const std::string &id)
Definition: Edge.cpp:83
libsumo::Edge::mySubscriptionResults
static SubscriptionResults mySubscriptionResults
Definition: Edge.h:101
libsumo::Edge::getElectricityConsumption
static double getElectricityConsumption(const std::string &id)
Definition: Edge.cpp:202
libsumo::Edge::getCO2Emission
static double getCO2Emission(const std::string &id)
Definition: Edge.cpp:129
LIBSUMO_SUBSCRIPTION_API
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:41
libsumo::Edge::getLastStepPersonIDs
static const std::vector< std::string > getLastStepPersonIDs(const std::string &id)
Definition: Edge.cpp:103
libsumo::Edge::adaptTraveltime
static void adaptTraveltime(const std::string &id, double value, double begTime=0., double endTime=std::numeric_limits< double >::max())
Definition: Edge.cpp:319
libsumo::Edge::getLastStepOccupancy
static double getLastStepOccupancy(const std::string &id)
Definition: Edge.cpp:228
libsumo::Edge::setParameter
static void setParameter(const std::string &id, const std::string &name, const std::string &value)
Definition: Edge.cpp:339
libsumo::Edge::setAllowedSVCPermissions
static void setAllowedSVCPermissions(const std::string &id, int permissions)
Definition: Edge.cpp:306
libsumo::VariableWrapper
Definition: Subscription.h:132
libsumo::Edge::setMaxSpeed
static void setMaxSpeed(const std::string &id, double value)
Definition: Edge.cpp:331
libsumo::Edge::storeShape
static LIBSUMO_SUBSCRIPTION_API void storeShape(const std::string &id, PositionVector &shape)
Saves the shape of the requested object in the given container.
Definition: Edge.cpp:348
libsumo::ContextSubscriptionResults
std::map< std::string, SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:204
libsumo::Edge::getHCEmission
static double getHCEmission(const std::string &id)
Definition: Edge.cpp:149
libsumo::Edge
Definition: Edge.h:51
libsumo::Edge::Edge
Edge()=delete
invalidated standard constructor
libsumo::Edge::getLastStepLength
static double getLastStepLength(const std::string &id)
Definition: Edge.cpp:255
PositionVector
A list of positions.
Definition: PositionVector.h:45
libsumo::Edge::getLastStepVehicleNumber
static int getLastStepVehicleNumber(const std::string &id)
Definition: Edge.cpp:212
libsumo::Edge::getIDList
static std::vector< std::string > getIDList()
Definition: Edge.cpp:41
libsumo
Definition: Edge.cpp:29
libsumo::Edge::getTraveltime
static double getTraveltime(const std::string &id)
Definition: Edge.cpp:77
libsumo::Edge::getIDCount
static int getIDCount()
Definition: Edge.cpp:49
TraCIConstants.h
libsumo::Edge::getParameter
static std::string getParameter(const std::string &id, const std::string &paramName)
Definition: Edge.cpp:286
libsumo::Edge::setAllowedVehicleClasses
static void setAllowedVehicleClasses(const std::string &id, std::vector< std::string > vector)
Definition: Edge.cpp:292
libsumo::Edge::getWaitingTime
static double getWaitingTime(const std::string &id)
Definition: Edge.cpp:93
libsumo::Edge::getNOxEmission
static double getNOxEmission(const std::string &id)
Definition: Edge.cpp:169
libsumo::Edge::setDisallowedVehicleClasses
static void setDisallowedVehicleClasses(const std::string &id, std::vector< std::string > classes)
Definition: Edge.cpp:299
MSEdge
A road/street connecting two junctions.
Definition: MSEdge.h:78
libsumo::Edge::setEffort
static void setEffort(const std::string &id, double value, double begTime=0., double endTime=std::numeric_limits< double >::max())
Definition: Edge.cpp:325
libsumo::Edge::getFuelConsumption
static double getFuelConsumption(const std::string &id)
Definition: Edge.cpp:179
libsumo::Edge::getStreetName
static std::string getStreetName(const std::string &id)
Definition: Edge.cpp:280
libsumo::Edge::makeWrapper
static std::shared_ptr< VariableWrapper > makeWrapper()
Definition: Edge.cpp:359
libsumo::Edge::getAdaptedTraveltime
static double getAdaptedTraveltime(const std::string &id, double time)
Definition: Edge.cpp:55
libsumo::Edge::handleVariable
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper)
Definition: Edge.cpp:365
libsumo::Edge::myContextSubscriptionResults
static ContextSubscriptionResults myContextSubscriptionResults
Definition: Edge.h:102
libsumo::Edge::getNoiseEmission
static double getNoiseEmission(const std::string &id)
Definition: Edge.cpp:189
libsumo::Edge::getLaneNumber
static int getLaneNumber(const std::string &id)
Definition: Edge.cpp:274
config.h
libsumo::Edge::getLastStepMeanSpeed
static double getLastStepMeanSpeed(const std::string &id)
Definition: Edge.cpp:222
TraCIDefs.h
libsumo::Edge::getCOEmission
static double getCOEmission(const std::string &id)
Definition: Edge.cpp:139
libsumo::SubscriptionResults
std::map< std::string, TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:203
libsumo::Edge::getPMxEmission
static double getPMxEmission(const std::string &id)
Definition: Edge.cpp:159
libsumo::Edge::getEffort
static double getEffort(const std::string &id, double time)
Definition: Edge.cpp:66
libsumo::Edge::getLastStepVehicleIDs
static const std::vector< std::string > getLastStepVehicleIDs(const std::string &id)
Definition: Edge.cpp:115