Eclipse SUMO - Simulation of Urban MObility
TrafficLight.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-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 /****************************************************************************/
20 // C++ TraCI client API implementation
21 /****************************************************************************/
22 #pragma once
23 #include <config.h>
24 
25 #include <vector>
26 #include <libsumo/TraCIDefs.h>
27 #include <libsumo/TraCIConstants.h>
28 #ifndef LIBTRACI
29 #ifndef SWIGJAVA
30 #ifndef SWIGPYTHON
32 #endif
33 #endif
34 #endif
35 
36 
37 // ===========================================================================
38 // class declarations
39 // ===========================================================================
40 #ifndef LIBTRACI
41 namespace libsumo {
42 class VariableWrapper;
43 }
44 #endif
45 
46 // ===========================================================================
47 // class definitions
48 // ===========================================================================
53 namespace LIBSUMO_NAMESPACE {
54 class TrafficLight {
55 public:
56 
57  static std::string getRedYellowGreenState(const std::string& tlsID);
58  static std::vector<libsumo::TraCILogic> getAllProgramLogics(const std::string& tlsID);
59  static std::vector<std::string> getControlledJunctions(const std::string& tlsID);
60  static std::vector<std::string> getControlledLanes(const std::string& tlsID);
61  static std::vector<std::vector<libsumo::TraCILink> > getControlledLinks(const std::string& tlsID);
62  static std::string getProgram(const std::string& tlsID);
63  static int getPhase(const std::string& tlsID);
64  static std::string getPhaseName(const std::string& tlsID);
65  static double getPhaseDuration(const std::string& tlsID);
66  static double getNextSwitch(const std::string& tlsID);
67  static int getServedPersonCount(const std::string& tlsID, int index);
68  static std::vector<std::string> getBlockingVehicles(const std::string& tlsID, int linkIndex);
69  static std::vector<std::string> getRivalVehicles(const std::string& tlsID, int linkIndex);
70  static std::vector<std::string> getPriorityVehicles(const std::string& tlsID, int linkIndex);
71 
74 
75 
76  static void setRedYellowGreenState(const std::string& tlsID, const std::string& state);
77  static void setPhase(const std::string& tlsID, const int index);
78  static void setPhaseName(const std::string& tlsID, const std::string& name);
79  static void setProgram(const std::string& tlsID, const std::string& programID);
80  static void setPhaseDuration(const std::string& tlsID, const double phaseDuration);
81  static void setProgramLogic(const std::string& tlsID, const libsumo::TraCILogic& logic);
82 
83  // aliases for backward compatibility
84  inline static std::vector<libsumo::TraCILogic> getCompleteRedYellowGreenDefinition(const std::string& tlsID) {
85  return getAllProgramLogics(tlsID);
86  }
87  inline static void setCompleteRedYellowGreenDefinition(const std::string& tlsID, const libsumo::TraCILogic& logic) {
88  setProgramLogic(tlsID, logic);
89  }
90 #ifndef LIBTRACI
91  static std::shared_ptr<VariableWrapper> makeWrapper();
92 
93  static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper);
94 
95 
96 private:
97 #ifndef SWIGJAVA
98 #ifndef SWIGPYTHON
99  static MSTLLogicControl::TLSLogicVariants& getTLS(const std::string& id);
100 #endif
101 #endif
102 
103 private:
106 #endif
108  TrafficLight() = delete;
109 };
110 
111 
112 }
#define LIBSUMO_ID_PARAMETER_API
Definition: TraCIDefs.h:97
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:44
static std::string getProgram(const std::string &tlsID)
static std::vector< std::string > getRivalVehicles(const std::string &tlsID, int linkIndex)
static std::vector< libsumo::TraCILogic > getCompleteRedYellowGreenDefinition(const std::string &tlsID)
Definition: TrafficLight.h:84
static void setProgramLogic(const std::string &tlsID, const libsumo::TraCILogic &logic)
static ContextSubscriptionResults myContextSubscriptionResults
Definition: TrafficLight.h:105
static void setProgram(const std::string &tlsID, const std::string &programID)
static void setCompleteRedYellowGreenDefinition(const std::string &tlsID, const libsumo::TraCILogic &logic)
Definition: TrafficLight.h:87
static int getPhase(const std::string &tlsID)
static double getPhaseDuration(const std::string &tlsID)
static void setPhaseName(const std::string &tlsID, const std::string &name)
static int getServedPersonCount(const std::string &tlsID, int index)
static std::shared_ptr< VariableWrapper > makeWrapper()
static std::vector< std::string > getControlledJunctions(const std::string &tlsID)
static std::vector< std::vector< libsumo::TraCILink > > getControlledLinks(const std::string &tlsID)
static std::vector< std::string > getControlledLanes(const std::string &tlsID)
static std::string getPhaseName(const std::string &tlsID)
static SubscriptionResults mySubscriptionResults
Definition: TrafficLight.h:104
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper)
static void setPhase(const std::string &tlsID, const int index)
static std::vector< std::string > getBlockingVehicles(const std::string &tlsID, int linkIndex)
TrafficLight()=delete
invalidated standard constructor
static std::string getRedYellowGreenState(const std::string &tlsID)
static void setPhaseDuration(const std::string &tlsID, const double phaseDuration)
static std::vector< libsumo::TraCILogic > getAllProgramLogics(const std::string &tlsID)
LIBSUMO_ID_PARAMETER_API static LIBSUMO_SUBSCRIPTION_API void setRedYellowGreenState(const std::string &tlsID, const std::string &state)
static MSTLLogicControl::TLSLogicVariants & getTLS(const std::string &id)
static std::vector< std::string > getPriorityVehicles(const std::string &tlsID, int linkIndex)
static double getNextSwitch(const std::string &tlsID)
Storage for all programs of a single tls.
std::map< std::string, TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:250
std::map< std::string, SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:251