Eclipse SUMO - Simulation of Urban MObility
GNEMultiEntryExitDetector.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 // Copyright (C) 2001-2024 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 "GNEAdditional.h"
23 
24 
25 // ===========================================================================
26 // class definitions
27 // ===========================================================================
33 
34 public:
37 
51  GNEMultiEntryExitDetector(const std::string& id, GNENet* net, const Position pos, const SUMOTime freq, const std::string& filename,
52  const std::vector<std::string>& vehicleTypes, const std::string& name, SUMOTime timeThreshold,
53  double speedThreshold, const bool expectedArrival, const Parameterised::Map& parameters);
54 
57 
62 
65 
69  void writeAdditional(OutputDevice& device) const;
70 
72  bool isAdditionalValid() const;
73 
75  std::string getAdditionalProblem() const;
76 
78  void fixAdditionalProblem();
79 
81 
84 
86  bool checkDrawMoveContour() const;
87 
89 
92 
94  void updateGeometry();
95 
98 
100  void updateCenteringBoundary(const bool updateGrid);
101 
103  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
104 
106 
109 
112  std::string getParentName() const;
113 
118  void drawGL(const GUIVisualizationSettings& s) const;
119 
121 
124 
125  /* @brief method for getting the Attribute of an XML key
126  * @param[in] key The attribute key
127  * @return string with the value associated to key
128  */
129  std::string getAttribute(SumoXMLAttr key) const;
130 
131  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
132  * @param[in] key The attribute key
133  * @return double with the value associated to key
134  */
135  double getAttributeDouble(SumoXMLAttr key) const;
136 
138  const Parameterised::Map& getACParametersMap() const;
139 
140  /* @brief method for setting the attribute and letting the object perform additional changes
141  * @param[in] key The attribute key
142  * @param[in] value The new value
143  * @param[in] undoList The undoList on which to register changes
144  */
145  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
146 
147  /* @brief method for checking if the key and their conrrespond attribute are valids
148  * @param[in] key The attribute key
149  * @param[in] value The value associated to key key
150  * @return true if the value is valid, false in other case
151  */
152  bool isValid(SumoXMLAttr key, const std::string& value);
153 
155  std::string getPopUpID() const;
156 
158  std::string getHierarchyName() const;
159 
161 
162 protected:
165 
168 
170  std::string myFilename;
171 
173  std::vector<std::string> myVehicleTypes;
174 
177 
179  double mySpeedThreshold = 0;
180 
182  bool myExpectedArrival = false;
183 
184 private:
186  bool checkChildAdditionalRestriction() const;
187 
189  void setAttribute(SumoXMLAttr key, const std::string& value);
190 
192  void setMoveShape(const GNEMoveResult& moveResult);
193 
195  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
196 
199 
202 };
long long int SUMOTime
Definition: GUI.h:35
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belong to GNENet but has influence in the simulation.
Definition: GNEAdditional.h:49
move operation
move result
bool isAdditionalValid() const
check if current additional is valid to be written into XML (must be reimplemented in all detector ch...
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
bool myExpectedArrival
flag for enable/disable expected arrival
bool checkDrawMoveContour() const
check if draw move contour (red)
std::string getAttribute(SumoXMLAttr key) const
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
std::vector< std::string > myVehicleTypes
attribute vehicle types
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
SUMOTime myTimeThreshold
The time-based threshold that describes how much time has to pass until a vehicle is recognized as ha...
bool checkChildAdditionalRestriction() const
check restriction with the number of children
GNEMultiEntryExitDetector(const GNEMultiEntryExitDetector &)=delete
Invalidated copy constructor.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
Position myPosition
position of E3 in view
double getAttributeDouble(SumoXMLAttr key) const
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
void fixAdditionalProblem()
fix additional problem (must be reimplemented in all detector children)
Position getPositionInView() const
Returns position of additional in view.
GNEMultiEntryExitDetector & operator=(const GNEMultiEntryExitDetector &)=delete
Invalidated assignment operator.
std::string getParentName() const
Returns the name of the parent object.
~GNEMultiEntryExitDetector()
GNEMultiEntryExitDetector Destructor.
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
GNEMultiEntryExitDetector(GNENet *net)
default constructor
std::string getAdditionalProblem() const
return a string with the current additional problem (must be reimplemented in all detector children)
SUMOTime myPeriod
period of E3 detector
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
const Parameterised::Map & getACParametersMap() const
get parameters map
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void updateGeometry()
update pre-computed geometry information
GNEMoveOperation * getMoveOperation()
get move operation
std::string myFilename
fielname of E3 detector
double mySpeedThreshold
The speed-based threshold that describes how slow a vehicle has to be to be recognized as halting.
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
An upper class for objects with additional parameters.
Definition: Parameterised.h:41
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37