Eclipse SUMO - Simulation of Urban MObility
Route.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2012-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 /****************************************************************************/
16 // C++ TraCI client API implementation
17 /****************************************************************************/
18 #ifndef Route_h
19 #define Route_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <vector>
28 #include <libsumo/TraCIDefs.h>
29 
30 
31 // ===========================================================================
32 // class declarations
33 // ===========================================================================
34 class MSRoute;
35 namespace libsumo {
36 class VariableWrapper;
37 }
38 
39 
40 // ===========================================================================
41 // class definitions
42 // ===========================================================================
47 namespace libsumo {
48 class Route {
49 public:
50 
51  static std::vector<std::string> getIDList();
52  static int getIDCount();
53  static std::vector<std::string> getEdges(const std::string& routeID);
54  static std::string getParameter(const std::string& routeID, const std::string& param);
55 
56  static void add(const std::string& routeID, const std::vector<std::string>& edgeIDs);
57  static void setParameter(const std::string& routeID, const std::string& key, const std::string& value); // not needed so far
58 
60 
61  static std::shared_ptr<VariableWrapper> makeWrapper();
62 
63  static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper);
64 
65 private:
66  static const MSRoute* getRoute(const std::string& id);
67 
68 private:
71 
73  Route() = delete;
74 };
75 
76 
77 }
78 
79 
80 #endif
81 
82 /****************************************************************************/
LIBSUMO_SUBSCRIPTION_API
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:41
libsumo::Route::handleVariable
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper)
Definition: Route.cpp:123
libsumo::Route::myContextSubscriptionResults
static ContextSubscriptionResults myContextSubscriptionResults
Definition: Route.h:70
libsumo::VariableWrapper
Definition: Subscription.h:132
libsumo::Route::makeWrapper
static LIBSUMO_SUBSCRIPTION_API std::shared_ptr< VariableWrapper > makeWrapper()
Definition: Route.cpp:117
libsumo::ContextSubscriptionResults
std::map< std::string, SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:204
MSRoute
Definition: MSRoute.h:66
libsumo::Route::getEdges
static std::vector< std::string > getEdges(const std::string &routeID)
Definition: Route.cpp:54
libsumo
Definition: Edge.cpp:29
libsumo::Route::add
static void add(const std::string &routeID, const std::vector< std::string > &edgeIDs)
Definition: Route.cpp:84
libsumo::Route::mySubscriptionResults
static SubscriptionResults mySubscriptionResults
Definition: Route.h:69
libsumo::Route::getIDList
static std::vector< std::string > getIDList()
Definition: Route.cpp:47
libsumo::Route::setParameter
static void setParameter(const std::string &routeID, const std::string &key, const std::string &value)
Definition: Route.cpp:77
libsumo::Route::getIDCount
static int getIDCount()
Definition: Route.cpp:65
libsumo::Route::Route
Route()=delete
invalidated standard constructor
libsumo::Route
Definition: Route.h:48
config.h
libsumo::Route::getRoute
static const MSRoute * getRoute(const std::string &id)
Definition: Route.cpp:107
TraCIDefs.h
libsumo::Route::getParameter
static std::string getParameter(const std::string &routeID, const std::string &param)
Definition: Route.cpp:71
libsumo::SubscriptionResults
std::map< std::string, TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:203