Eclipse SUMO - Simulation of Urban MObility
GNERerouter.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 // class declarations
26 // ===========================================================================
27 
28 class GNEEdge;
29 
30 // ===========================================================================
31 // class definitions
32 // ===========================================================================
37 class GNERerouter : public GNEAdditional, public Parameterised {
38 
39 public:
41  GNERerouter(GNENet* net);
42 
52  GNERerouter(const std::string& id, GNENet* net, const Position& pos, const std::string& name,
53  double probability, bool off, bool optional, SUMOTime timeThreshold, const std::vector<std::string>& vTypes,
54  const Parameterised::Map& parameters);
55 
57  ~GNERerouter();
58 
63 
65  void openAdditionalDialog();
66 
69 
73  void writeAdditional(OutputDevice& device) const;
74 
76  bool isAdditionalValid() const;
77 
79  std::string getAdditionalProblem() const;
80 
82  void fixAdditionalProblem();
83 
85 
88 
90  bool checkDrawMoveContour() const;
91 
93 
96 
98  void updateGeometry();
99 
101  Position getPositionInView() const;
102 
104  void updateCenteringBoundary(const bool updateGrid);
105 
107  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
108 
110 
113 
116  std::string getParentName() const;
117 
122  void drawGL(const GUIVisualizationSettings& s) const;
123 
125 
128 
129  /* @brief method for getting the Attribute of an XML key
130  * @param[in] key The attribute key
131  * @return string with the value associated to key
132  */
133  std::string getAttribute(SumoXMLAttr key) const;
134 
135  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
136  * @param[in] key The attribute key
137  * @return double with the value associated to key
138  */
139  double getAttributeDouble(SumoXMLAttr key) const;
140 
142  const Parameterised::Map& getACParametersMap() const;
143 
144  /* @brief method for setting the attribute and letting the object perform additional changes
145  * @param[in] key The attribute key
146  * @param[in] value The new value
147  * @param[in] undoList The undoList on which to register changes
148  */
149  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
150 
151  /* @brief method for checking if the key and their correspond attribute are valids
152  * @param[in] key The attribute key
153  * @param[in] value The value associated to key key
154  * @return true if the value is valid, false in other case
155  */
156  bool isValid(SumoXMLAttr key, const std::string& value);
157 
159  std::string getPopUpID() const;
160 
162  std::string getHierarchyName() const;
163 
165 
166 protected:
169 
172 
174  bool myOff;
175 
178 
181 
183  std::vector<std::string> myVTypes;
184 
185 private:
187  void setAttribute(SumoXMLAttr key, const std::string& value);
188 
190  void setMoveShape(const GNEMoveResult& moveResult);
191 
193  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
194 
196  void rebuildRerouterSymbols(const std::string& value, GNEUndoList* undoList);
197 
199  GNERerouter(const GNERerouter&) = delete;
200 
202  GNERerouter& operator=(const GNERerouter&) = delete;
203 };
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
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:53
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
SUMOTime myTimeThreshold
attribute to configure activation time threshold
Definition: GNERerouter.h:180
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
double getAttributeDouble(SumoXMLAttr key) const
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
const Parameterised::Map & getACParametersMap() const
get parameters map
void rebuildRerouterSymbols(const std::string &value, GNEUndoList *undoList)
rebuild Rerouter Symbols
std::vector< std::string > myVTypes
optional vehicle types for restricting the rerouter
Definition: GNERerouter.h:183
Position myPosition
position of rerouter in view
Definition: GNERerouter.h:168
bool isAdditionalValid() const
check if current additional is valid to be written into XML (must be reimplemented in all detector ch...
bool myOff
attribute to enable or disable inactive initially
Definition: GNERerouter.h:174
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Position getPositionInView() const
Returns position of additional in view.
GNERerouter(GNENet *net)
default Constructor
Definition: GNERerouter.cpp:35
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
Definition: GNERerouter.cpp:69
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
GNERerouter & operator=(const GNERerouter &)=delete
Invalidated assignment operator.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
double myProbability
probability of rerouter
Definition: GNERerouter.h:171
std::string getParentName() const
Returns the name of the parent object.
void fixAdditionalProblem()
fix additional problem (must be reimplemented in all detector children)
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
void openAdditionalDialog()
open GNERerouterDialog
~GNERerouter()
Destructor.
Definition: GNERerouter.cpp:64
std::string getAttribute(SumoXMLAttr key) const
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
bool myOptional
attribute to enable or disable request trigger
Definition: GNERerouter.h:177
std::string getAdditionalProblem() const
return a string with the current additional problem (must be reimplemented in all detector children)
bool checkDrawMoveContour() const
check if draw move contour (red)
GNEMoveOperation * getMoveOperation()
get move operation
void updateGeometry()
update pre-computed geometry information
GNERerouter(const GNERerouter &)=delete
Invalidated copy constructor.
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