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-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 /****************************************************************************/
18 //
19 /****************************************************************************/
20 #pragma once
21 #include "GNEAdditional.h"
22 
23 
24 // ===========================================================================
25 // class definitions
26 // ===========================================================================
31 class GNEDetectorE3 : public GNEAdditional {
32 
33 public:
46  GNEDetectorE3(const std::string& id, GNENet* net, Position pos, SUMOTime freq, const std::string& filename, const std::string& vehicleTypes, const std::string& name, SUMOTime timeThreshold, double speedThreshold, bool blockMovement);
47 
50 
54  GNEMoveOperation* getMoveOperation(const double shapeOffset);
55 
59  void updateGeometry();
60 
62  void updateCenteringBoundary(const bool updateGrid);
63 
65  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
67 
72  std::string getParentName() const;
73 
78  void drawGL(const GUIVisualizationSettings& s) const;
80 
83  /* @brief method for getting the Attribute of an XML key
84  * @param[in] key The attribute key
85  * @return string with the value associated to key
86  */
87  std::string getAttribute(SumoXMLAttr key) const;
88 
89  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
90  * @param[in] key The attribute key
91  * @return double with the value associated to key
92  */
93  double getAttributeDouble(SumoXMLAttr key) const;
94 
95  /* @brief method for setting the attribute and letting the object perform additional changes
96  * @param[in] key The attribute key
97  * @param[in] value The new value
98  * @param[in] undoList The undoList on which to register changes
99  */
100  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
101 
102  /* @brief method for checking if the key and their conrrespond attribute are valids
103  * @param[in] key The attribute key
104  * @param[in] value The value asociated to key key
105  * @return true if the value is valid, false in other case
106  */
107  bool isValid(SumoXMLAttr key, const std::string& value);
108 
109  /* @brief method for check if the value for certain attribute is set
110  * @param[in] key The attribute key
111  */
112  bool isAttributeEnabled(SumoXMLAttr key) const;
113 
115  std::string getPopUpID() const;
116 
118  std::string getHierarchyName() const;
120 
121 protected:
124 
127 
129  std::string myFilename;
130 
132  std::string myVehicleTypes;
133 
136 
139 
140 private:
142  bool checkChildAdditionalRestriction() const;
143 
145  void setAttribute(SumoXMLAttr key, const std::string& value);
146 
148  void setMoveShape(const GNEMoveResult& moveResult);
149 
151  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
152 
154  GNEDetectorE3(const GNEDetectorE3&) = delete;
155 
158 };
long long int SUMOTime
Definition: SUMOTime.h:31
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:47
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 drawGL(const GUIVisualizationSettings &s) const
Draws the object.
~GNEDetectorE3()
GNEDetectorE3 Destructor.
GNEDetectorE3(const GNEDetectorE3 &)=delete
Invalidated copy constructor.
bool checkChildAdditionalRestriction() const
check restriction with the number of children
GNEDetectorE3 & operator=(const GNEDetectorE3 &)=delete
Invalidated assignment operator.
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
GNEMoveOperation * getMoveOperation(const double shapeOffset)
get move operation for the given shapeOffset
SUMOTime myFreq
frequency of E3 detector
GNEDetectorE3(const std::string &id, GNENet *net, Position pos, SUMOTime freq, const std::string &filename, const std::string &vehicleTypes, const std::string &name, SUMOTime timeThreshold, double speedThreshold, bool blockMovement)
GNEDetectorE3 Constructor.
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)
std::string myVehicleTypes
attribute vehicle types
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:40
Stores the information about how to visualize structures.
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:36