Eclipse SUMO - Simulation of Urban MObility
GNELaneAreaDetector.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-2022 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//
19/****************************************************************************/
20#pragma once
21#include <config.h>
22#include "GNEDetector.h"
23
24
25// ===========================================================================
26// class definitions
27// ===========================================================================
33
34public:
37
55 GNELaneAreaDetector(const std::string& id, GNELane* lane, GNENet* net, double pos, double length, const SUMOTime freq, const std::string& trafficLight,
56 const std::string& filename, const std::vector<std::string>& vehicleTypes, const std::string& name, SUMOTime timeThreshold, double speedThreshold,
57 double jamThreshold, bool friendlyPos, const Parameterised::Map& parameters);
58
76 GNELaneAreaDetector(const std::string& id, std::vector<GNELane*> lanes, GNENet* net, double pos, double endPos, const SUMOTime freq, const std::string& trafficLight,
77 const std::string& filename, const std::vector<std::string>& vehicleTypes, const std::string& name, SUMOTime timeThreshold, double speedThreshold, double jamThreshold,
78 bool friendlyPos, const Parameterised::Map& parameters);
79
82
85
88 void writeAdditional(OutputDevice& device) const;
89
91 bool isAdditionalValid() const;
92
94 std::string getAdditionalProblem() const;
95
99
101 void updateGeometry();
102
105
109 void drawGL(const GUIVisualizationSettings& s) const;
111
114
116 void computePathElement();
117
123 void drawPartialGL(const GUIVisualizationSettings& s, const GNELane* lane, const GNEPathManager::Segment* segment, const double offsetFront) const;
124
131 void drawPartialGL(const GUIVisualizationSettings& s, const GNELane* fromLane, const GNELane* toLane, const GNEPathManager::Segment* segment, const double offsetFront) const;
132
134
137 /* @brief method for getting the Attribute of an XML key
138 * @param[in] key The attribute key
139 * @return string with the value associated to key
140 */
141 std::string getAttribute(SumoXMLAttr key) const;
142
143 /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
144 * @param[in] key The attribute key
145 * @return double with the value associated to key
146 */
147 double getAttributeDouble(SumoXMLAttr key) const;
148
149 /* @brief method for setting the attribute and letting the object perform additional changes
150 * @param[in] key The attribute key
151 * @param[in] value The new value
152 * @param[in] undoList The undoList on which to register changes
153 */
154 void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
155
156 /* @brief method for checking if the key and their correspond attribute are valids
157 * @param[in] key The attribute key
158 * @param[in] value The value associated to key key
159 * @return true if the value is valid, false in other case
160 */
161 bool isValid(SumoXMLAttr key, const std::string& value);
163
164protected:
167
170
173
176
178 std::string myTrafficLight;
179
180private:
182 void setAttribute(SumoXMLAttr key, const std::string& value);
183
185 void setMoveShape(const GNEMoveResult& moveResult);
186
188 void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
189
192
194 double getEndGeometryPositionOverLane() const;
195
198
201};
long long int SUMOTime
Definition: GUI.h:36
SumoXMLTag
Numbers representing SUMO-XML - element names.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
GNELaneAreaDetector & operator=(const GNELaneAreaDetector &)=delete
Invalidated assignment operator.
void drawPartialGL(const GUIVisualizationSettings &s, const GNELane *lane, const GNEPathManager::Segment *segment, const double offsetFront) const
Draws partial object (lane)
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
void updateGeometry()
update pre-computed geometry information
double getAttributeDouble(SumoXMLAttr key) const
void fixAdditionalProblem()
fix additional problem
std::string getAttribute(SumoXMLAttr key) const
double myJamThreshold
The minimum distance to the next standing vehicle in order to make this vehicle count as a participan...
std::string myTrafficLight
Traffic light vinculated with this E2 Detector.
~GNELaneAreaDetector()
Destructor.
double myEndPositionOverLane
end position over lane (only for Multilane E2 detectors)
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
double getStartGeometryPositionOverLane() const
get start position over lane that is applicable to the shape
bool isAdditionalValid() const
check if current additional is valid to be writed into XML
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
GNELaneAreaDetector(SumoXMLTag tag, GNENet *net)
default Constructor
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
double mySpeedThreshold
The speed-based threshold that describes how slow a vehicle has to be to be recognized as halting.
std::string getAdditionalProblem() const
return a string with the current additional problem
double getEndGeometryPositionOverLane() const
get end position over lane that is applicable to the shape
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
GNELaneAreaDetector(const GNELaneAreaDetector &)=delete
Invalidated copy constructor.
SUMOTime myTimeThreshold
The time-based threshold that describes how much time has to pass until a vehicle is recognized as ha...
void computePathElement()
compute pathElement
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45