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-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
15 //
16 /****************************************************************************/
17 #ifndef GNERouteProbe_h
18 #define GNERouteProbe_h
19 
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 
25 #include "GNEAdditional.h"
26 
27 
28 // ===========================================================================
29 // class definitions
30 // ===========================================================================
35 class GNERouteProbe : public GNEAdditional {
36 
37 public:
47  GNERouteProbe(const std::string& id, GNEViewNet* viewNet, GNEEdge* edge, const std::string& frequency, const std::string& name, const std::string& filename, SUMOTime begin);
48 
51 
54 
57  void moveGeometry(const Position& offset);
58 
62  void commitGeometryMoving(GNEUndoList* undoList);
63 
65  void updateGeometry();
66 
69 
73 
78  std::string getParentName() const;
79 
84  void drawGL(const GUIVisualizationSettings& s) const;
86 
89  /* @brief method for getting the Attribute of an XML key
90  * @param[in] key The attribute key
91  * @return string with the value associated to key
92  */
93  std::string getAttribute(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 correspond 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 
110  std::string getPopUpID() const;
111 
113  std::string getHierarchyName() const;
115 
116 protected:
118  std::string myFrequency;
119 
121  std::string myFilename;
122 
125 
128 
131 
132 private:
134  void setAttribute(SumoXMLAttr key, const std::string& value);
135 
137  GNERouteProbe(const GNERouteProbe&) = delete;
138 
140  GNERouteProbe& operator=(const GNERouteProbe&) = delete;
141 };
142 
143 #endif
144 
145 /****************************************************************************/
GNERouteProbe::myBegin
SUMOTime myBegin
begin of rerouter
Definition: GNERouteProbe.h:124
GNEAdditional
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:47
GNERouteProbe::getPositionInView
Position getPositionInView() const
Returns position of additional in view.
Definition: GNERouteProbe.cpp:85
GNEAdditional.h
GNERouteProbe::updateGeometry
void updateGeometry()
update pre-computed geometry information
Definition: GNERouteProbe.cpp:56
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:35
GNEViewNet
Definition: GNEViewNet.h:43
GNERouteProbe
Representation of a RouteProbe in netedit.
Definition: GNERouteProbe.h:35
GNEEdge
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:50
GNERouteProbe::GNERouteProbe
GNERouteProbe(const std::string &id, GNEViewNet *viewNet, GNEEdge *edge, const std::string &frequency, const std::string &name, const std::string &filename, SUMOTime begin)
Constructor.
Definition: GNERouteProbe.cpp:40
GNERouteProbe::myRouteProbeLogoOffset
Position myRouteProbeLogoOffset
route probe logo offset
Definition: GNERouteProbe.h:127
GNERouteProbe::operator=
GNERouteProbe & operator=(const GNERouteProbe &)=delete
Invalidated assignment operator.
GNERouteProbe::myFilename
std::string myFilename
filename of RouteProbe
Definition: GNERouteProbe.h:121
Boundary
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:42
GNERouteProbe::getAttribute
std::string getAttribute(SumoXMLAttr key) const
Definition: GNERouteProbe.cpp:203
Position
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:39
GNERouteProbe::~GNERouteProbe
~GNERouteProbe()
Destructor.
Definition: GNERouteProbe.cpp:51
GNERouteProbe::setAttribute
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
Definition: GNERouteProbe.cpp:228
GNERouteProbe::getParentName
std::string getParentName() const
Returns the name of the parent object (if any)
Definition: GNERouteProbe.cpp:116
GNERouteProbe::moveGeometry
void moveGeometry(const Position &offset)
change the position of the element geometry without saving in undoList
Definition: GNERouteProbe.cpp:104
GNERouteProbe::myFrequency
std::string myFrequency
Frequency of RouteProbe.
Definition: GNERouteProbe.h:118
GNERouteProbe::getHierarchyName
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
Definition: GNERouteProbe.cpp:256
GNERouteProbe::getPopUpID
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
Definition: GNERouteProbe.cpp:250
GNERouteProbe::myRelativePositionY
int myRelativePositionY
relative position regarding to other route probes
Definition: GNERouteProbe.h:130
GNEUndoList
Definition: GNEUndoList.h:49
GUIVisualizationSettings
Stores the information about how to visualize structures.
Definition: GUIVisualizationSettings.h:346
SumoXMLAttr
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
Definition: SUMOXMLDefinitions.h:373
GNERouteProbe::commitGeometryMoving
void commitGeometryMoving(GNEUndoList *undoList)
commit geometry changes in the attributes of an element after use of moveGeometry(....
Definition: GNERouteProbe.cpp:110
GNERouteProbe::isValid
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
Definition: GNERouteProbe.cpp:265
GNERouteProbe::drawGL
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Definition: GNERouteProbe.cpp:122
GNERouteProbe::getCenteringBoundary
Boundary getCenteringBoundary() const
Returns the boundary to which the view shall be centered in order to show the object.
Definition: GNERouteProbe.cpp:98