Eclipse SUMO - Simulation of Urban MObility
GNEDetectorE3.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 "GNEAdditional.h"
23 
24 
25 // ===========================================================================
26 // class definitions
27 // ===========================================================================
32 class GNEDetectorE3 : public GNEAdditional {
33 
34 public:
36  GNEDetectorE3(GNENet* net);
37 
50  GNEDetectorE3(const std::string& id, GNENet* net, const Position pos, const SUMOTime freq, const std::string& filename, const std::vector<std::string>& vehicleTypes,
51  const std::string& name, SUMOTime timeThreshold, double speedThreshold, const std::map<std::string, std::string>& parameters);
52 
55 
60 
63 
66  void writeAdditional(OutputDevice& device) const;
67 
69  void updateGeometry();
70 
73 
75  void updateCenteringBoundary(const bool updateGrid);
76 
78  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
80 
85  std::string getParentName() const;
86 
91  void drawGL(const GUIVisualizationSettings& s) const;
93 
96  /* @brief method for getting the Attribute of an XML key
97  * @param[in] key The attribute key
98  * @return string with the value associated to key
99  */
100  std::string getAttribute(SumoXMLAttr key) const;
101 
102  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
103  * @param[in] key The attribute key
104  * @return double with the value associated to key
105  */
106  double getAttributeDouble(SumoXMLAttr key) const;
107 
108  /* @brief method for setting the attribute and letting the object perform additional changes
109  * @param[in] key The attribute key
110  * @param[in] value The new value
111  * @param[in] undoList The undoList on which to register changes
112  */
113  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
114 
115  /* @brief method for checking if the key and their conrrespond attribute are valids
116  * @param[in] key The attribute key
117  * @param[in] value The value asociated to key key
118  * @return true if the value is valid, false in other case
119  */
120  bool isValid(SumoXMLAttr key, const std::string& value);
121 
122  /* @brief method for check if the value for certain attribute is set
123  * @param[in] key The attribute key
124  */
125  bool isAttributeEnabled(SumoXMLAttr key) const;
126 
128  std::string getPopUpID() const;
129 
131  std::string getHierarchyName() const;
133 
134 protected:
137 
140 
142  std::string myFilename;
143 
145  std::vector<std::string> myVehicleTypes;
146 
149 
152 
153 private:
155  bool checkChildAdditionalRestriction() const;
156 
158  void setAttribute(SumoXMLAttr key, const std::string& value);
159 
161  void setMoveShape(const GNEMoveResult& moveResult);
162 
164  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
165 
167  GNEDetectorE3(const GNEDetectorE3&) = delete;
168 
171 };
long long int SUMOTime
Definition: SUMOTime.h:32
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:48
std::string getAttribute(SumoXMLAttr key) const
std::string myFilename
fielname of E3 detector
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
bool isAttributeEnabled(SumoXMLAttr key) const
double mySpeedThreshold
The speed-based threshold that describes how slow a vehicle has to be to be recognized as halting.
double getAttributeDouble(SumoXMLAttr key) const
void updateGeometry()
update pre-computed geometry information
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
void writeAdditional(OutputDevice &device) const
writte additional element into a xml file
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
~GNEDetectorE3()
GNEDetectorE3 Destructor.
GNEDetectorE3(const GNEDetectorE3 &)=delete
Invalidated copy constructor.
GNEDetectorE3(GNENet *net)
default constructor
GNEMoveOperation * getMoveOperation()
get move operation
bool checkChildAdditionalRestriction() const
check restriction with the number of children
GNEDetectorE3 & operator=(const GNEDetectorE3 &)=delete
Invalidated assignment operator.
std::vector< std::string > myVehicleTypes
attribute vehicle types
std::string getParentName() const
Returns the name of the parent object (if any)
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
Position myPosition
position of E3 in view
Position getPositionInView() const
Returns position of additional in view.
SUMOTime myFreq
frequency of E3 detector
SUMOTime myTimeThreshold
The time-based threshold that describes how much time has to pass until a vehicle is recognized as ha...
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
move operation
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
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37