Eclipse SUMO - Simulation of Urban MObility
GNERouteProbe.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 GNERouteProbe : public GNEAdditional {
33 
34 public:
36  GNERouteProbe(GNENet* net);
37 
48  GNERouteProbe(const std::string& id, GNENet* net, GNEEdge* edge, const SUMOTime frequency, const std::string& name,
49  const std::string& filename, SUMOTime begin, const std::map<std::string, std::string>& parameters);
50 
53 
57  void writeAdditional(OutputDevice& device) const;
58 
63 
67  void updateGeometry();
68 
71 
73  void updateCenteringBoundary(const bool updateGrid);
74 
76  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
78 
83  std::string getParentName() const;
84 
89  void drawGL(const GUIVisualizationSettings& s) const;
91 
94  /* @brief method for getting the Attribute of an XML key
95  * @param[in] key The attribute key
96  * @return string with the value associated to key
97  */
98  std::string getAttribute(SumoXMLAttr key) const;
99 
100  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
101  * @param[in] key The attribute key
102  * @return double with the value associated to key
103  */
104  double getAttributeDouble(SumoXMLAttr key) const;
105 
106  /* @brief method for setting the attribute and letting the object perform additional changes
107  * @param[in] key The attribute key
108  * @param[in] value The new value
109  * @param[in] undoList The undoList on which to register changes
110  */
111  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
112 
113  /* @brief method for checking if the key and their correspond attribute are valids
114  * @param[in] key The attribute key
115  * @param[in] value The value asociated to key key
116  * @return true if the value is valid, false in other case
117  */
118  bool isValid(SumoXMLAttr key, const std::string& value);
119 
120  /* @brief method for check if the value for certain attribute is set
121  * @param[in] key The attribute key
122  */
123  bool isAttributeEnabled(SumoXMLAttr key) const;
124 
126  std::string getPopUpID() const;
127 
129  std::string getHierarchyName() const;
131 
132 protected:
135 
137  std::string myFilename;
138 
141 
144 
145 private:
147  void setAttribute(SumoXMLAttr key, const std::string& value);
148 
150  void setMoveShape(const GNEMoveResult& moveResult);
151 
153  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
154 
156  GNERouteProbe(const GNERouteProbe&) = delete;
157 
160 };
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
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
Representation of a RouteProbe in netedit.
Definition: GNERouteProbe.h:32
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
SUMOTime myBegin
begin of rerouter
void writeAdditional(OutputDevice &device) const
writte additional element into a xml file
Position getPositionInView() const
Returns position of additional in view.
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
std::string getParentName() const
Returns the name of the parent object (if any)
std::string myFilename
filename of RouteProbe
bool isAttributeEnabled(SumoXMLAttr key) const
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
GNERouteProbe(const GNERouteProbe &)=delete
Invalidated copy constructor.
void updateGeometry()
update pre-computed geometry information
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
GNEMoveOperation * getMoveOperation()
get move operation
SUMOTime myFrequency
Frequency of RouteProbe.
~GNERouteProbe()
Destructor.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
Position myRouteProbeLogoOffset
route probe logo offset
std::string getAttribute(SumoXMLAttr key) const
GNERouteProbe & operator=(const GNERouteProbe &)=delete
Invalidated assignment operator.
double getAttributeDouble(SumoXMLAttr key) const
GNERouteProbe(GNENet *net)
Constructor.
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
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