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 /****************************************************************************/
14 //
15 /****************************************************************************/
16 #ifndef GNERouteProbe_h
17 #define GNERouteProbe_h
18 
19 
20 // ===========================================================================
21 // included modules
22 // ===========================================================================
23 
24 #include "GNEAdditional.h"
25 
26 
27 // ===========================================================================
28 // class definitions
29 // ===========================================================================
34 class GNERouteProbe : public GNEAdditional {
35 
36 public:
46  GNERouteProbe(const std::string& id, GNEViewNet* viewNet, GNEEdge* edge, const std::string& frequency, const std::string& name, const std::string& filename, SUMOTime begin);
47 
50 
53 
56  void moveGeometry(const Position& offset);
57 
61  void commitGeometryMoving(GNEUndoList* undoList);
62 
64  void updateGeometry();
65 
68 
71 
73  void splitEdgeGeometry(const double splitPosition, const GNENetElement* originalElement, const GNENetElement* newElement, GNEUndoList* undoList);
75 
80  std::string getParentName() const;
81 
86  void drawGL(const GUIVisualizationSettings& s) const;
88 
91  /* @brief method for getting the Attribute of an XML key
92  * @param[in] key The attribute key
93  * @return string with the value associated to key
94  */
95  std::string getAttribute(SumoXMLAttr key) const;
96 
97  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
98  * @param[in] key The attribute key
99  * @return double with the value associated to key
100  */
101  double getAttributeDouble(SumoXMLAttr key) const;
102 
103  /* @brief method for setting the attribute and letting the object perform additional changes
104  * @param[in] key The attribute key
105  * @param[in] value The new value
106  * @param[in] undoList The undoList on which to register changes
107  */
108  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
109 
110  /* @brief method for checking if the key and their correspond attribute are valids
111  * @param[in] key The attribute key
112  * @param[in] value The value asociated to key key
113  * @return true if the value is valid, false in other case
114  */
115  bool isValid(SumoXMLAttr key, const std::string& value);
116 
117  /* @brief method for check if the value for certain attribute is set
118  * @param[in] key The attribute key
119  */
120  bool isAttributeEnabled(SumoXMLAttr key) const;
121 
123  std::string getPopUpID() const;
124 
126  std::string getHierarchyName() const;
128 
129 protected:
131  std::string myFrequency;
132 
134  std::string myFilename;
135 
138 
141 
144 
145 private:
147  void setAttribute(SumoXMLAttr key, const std::string& value);
148 
150  GNERouteProbe(const GNERouteProbe&) = delete;
151 
154 };
155 
156 #endif
157 
158 /****************************************************************************/
GNERouteProbe::myBegin
SUMOTime myBegin
begin of rerouter
Definition: GNERouteProbe.h:137
GNEAdditional
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:48
GNERouteProbe::getPositionInView
Position getPositionInView() const
Returns position of additional in view.
Definition: GNERouteProbe.cpp:80
GNEAdditional.h
GNERouteProbe::GNERouteProbe
GNERouteProbe(const GNERouteProbe &)=delete
Invalidated copy constructor.
GNERouteProbe::updateGeometry
void updateGeometry()
update pre-computed geometry information
Definition: GNERouteProbe.cpp:55
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:34
GNEViewNet
Definition: GNEViewNet.h:42
GNERouteProbe
Representation of a RouteProbe in netedit.
Definition: GNERouteProbe.h:34
GNEEdge
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:51
GNERouteProbe::splitEdgeGeometry
void splitEdgeGeometry(const double splitPosition, const GNENetElement *originalElement, const GNENetElement *newElement, GNEUndoList *undoList)
split geometry
Definition: GNERouteProbe.cpp:99
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:39
GNERouteProbe::myRouteProbeLogoOffset
Position myRouteProbeLogoOffset
route probe logo offset
Definition: GNERouteProbe.h:140
GNERouteProbe::operator=
GNERouteProbe & operator=(const GNERouteProbe &)=delete
Invalidated assignment operator.
GNERouteProbe::myFilename
std::string myFilename
filename of RouteProbe
Definition: GNERouteProbe.h:134
Boundary
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:41
GNERouteProbe::getAttribute
std::string getAttribute(SumoXMLAttr key) const
Definition: GNERouteProbe.cpp:208
Position
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:38
GNENetElement
Definition: GNENetElement.h:43
GNERouteProbe::~GNERouteProbe
~GNERouteProbe()
Destructor.
Definition: GNERouteProbe.cpp:50
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:244
GNERouteProbe::getParentName
std::string getParentName() const
Returns the name of the parent object (if any)
Definition: GNERouteProbe.cpp:117
GNERouteProbe::moveGeometry
void moveGeometry(const Position &offset)
change the position of the element geometry without saving in undoList
Definition: GNERouteProbe.cpp:105
GNERouteProbe::myFrequency
std::string myFrequency
Frequency of RouteProbe.
Definition: GNERouteProbe.h:131
GNERouteProbe::getHierarchyName
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
Definition: GNERouteProbe.cpp:278
GNERouteProbe::getPopUpID
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
Definition: GNERouteProbe.cpp:272
GNERouteProbe::myRelativePositionY
int myRelativePositionY
relative position regarding to other route probes
Definition: GNERouteProbe.h:143
GNERouteProbe::isAttributeEnabled
bool isAttributeEnabled(SumoXMLAttr key) const
Definition: GNERouteProbe.cpp:266
GNEUndoList
Definition: GNEUndoList.h:48
GUIVisualizationSettings
Stores the information about how to visualize structures.
Definition: GUIVisualizationSettings.h:345
GNERouteProbe::getAttributeDouble
double getAttributeDouble(SumoXMLAttr key) const
Definition: GNERouteProbe.cpp:233
SumoXMLAttr
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
Definition: SUMOXMLDefinitions.h:372
GNERouteProbe::commitGeometryMoving
void commitGeometryMoving(GNEUndoList *undoList)
commit geometry changes in the attributes of an element after use of moveGeometry(....
Definition: GNERouteProbe.cpp:111
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:287
GNERouteProbe::drawGL
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Definition: GNERouteProbe.cpp:123
GNERouteProbe::getCenteringBoundary
Boundary getCenteringBoundary() const
Returns the boundary to which the view shall be centered in order to show the object.
Definition: GNERouteProbe.cpp:93