Eclipse SUMO - Simulation of Urban MObility
GNEEdgeData.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 // class for edge data
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 
28 #include "GNEGenericData.h"
29 
30 // ===========================================================================
31 // class definitions
32 // ===========================================================================
33 
38 class GNEEdgeData : public GNEGenericData {
39 
40 public:
46  GNEEdgeData(GNEDataInterval* dataIntervalParent, GNEEdge* edgeParent, const std::map<std::string, std::string>& parameters);
47 
49  ~GNEEdgeData();
50 
52  const RGBColor& getColor() const;
53 
55  bool isGenericDataVisible() const;
56 
58  void updateGeometry();
59 
62 
65 
68  void writeGenericData(OutputDevice& device) const;
69 
71  bool isGenericDataValid() const;
72 
74  std::string getGenericDataProblem() const;
75 
77  void fixGenericDataProblem();
79 
82 
87  void drawGL(const GUIVisualizationSettings& s) const;
88 
90  double getExaggeration(const GUIVisualizationSettings& s) const;
91 
94 
96 
99 
101  void computePathElement();
102 
109  void drawPartialGL(const GUIVisualizationSettings& s, const GNELane* lane, const GNEPathManager::Segment* segment, const double offsetFront) const;
110 
118  void drawPartialGL(const GUIVisualizationSettings& s, const GNELane* fromLane, const GNELane* toLane, const GNEPathManager::Segment* segment, const double offsetFront) const;
119 
121  GNELane* getFirstPathLane() const;
122 
124  GNELane* getLastPathLane() const;
126 
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 
146  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
147 
153  bool isValid(SumoXMLAttr key, const std::string& value);
154 
155  /* @brief method for enable attribute
156  * @param[in] key The attribute key
157  * @param[in] undoList The undoList on which to register changes
158  * @note certain attributes can be only enabled, and can produce the disabling of other attributes
159  */
160  void enableAttribute(SumoXMLAttr key, GNEUndoList* undoList);
161 
162  /* @brief method for disable attribute
163  * @param[in] key The attribute key
164  * @param[in] undoList The undoList on which to register changes
165  * @note certain attributes can be only enabled, and can produce the disabling of other attributes
166  */
167  void disableAttribute(SumoXMLAttr key, GNEUndoList* undoList);
168 
169  /* @brief method for check if the value for certain attribute is set
170  * @param[in] key The attribute key
171  */
172  bool isAttributeEnabled(SumoXMLAttr key) const;
173 
175  std::string getPopUpID() const;
176 
178  std::string getHierarchyName() const;
180 
181 private:
183  void setAttribute(SumoXMLAttr key, const std::string& value);
184 
186  void toogleAttribute(SumoXMLAttr key, const bool value, const int previousParameters);
187 
189  GNEEdgeData(const GNEEdgeData&) = delete;
190 
192  GNEEdgeData& operator=(const GNEEdgeData&) = delete;
193 };
194 
195 /****************************************************************************/
196 
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:39
An Element which don't belongs to GNENet but has influency in the simulation.
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEEdgeData.h:38
bool isGenericDataVisible() const
check if current edge data is visible
Definition: GNEEdgeData.cpp:82
GNEEdgeData & operator=(const GNEEdgeData &)=delete
Invalidated assignment operator.
std::string getAttribute(SumoXMLAttr key) const
void writeGenericData(OutputDevice &device) const
writte data set element into a xml file
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
GNEEdgeData(const GNEEdgeData &)=delete
Invalidated copy constructor.
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform data set changes
GNELane * getFirstPathLane() const
get first path lane
GNELane * getLastPathLane() const
get last path lane
void enableAttribute(SumoXMLAttr key, GNEUndoList *undoList)
bool isAttributeEnabled(SumoXMLAttr key) const
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
void disableAttribute(SumoXMLAttr key, GNEUndoList *undoList)
void toogleAttribute(SumoXMLAttr key, const bool value, const int previousParameters)
method for enable or disable the attribute and nothing else (used in GNEChange_EnableAttribute)
double getAttributeDouble(SumoXMLAttr key) const
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
void drawPartialGL(const GUIVisualizationSettings &s, const GNELane *lane, const GNEPathManager::Segment *segment, const double offsetFront) const
Draws partial object (lane)
Boundary getCenteringBoundary() const
~GNEEdgeData()
Destructor.
Definition: GNEEdgeData.cpp:54
void computePathElement()
compute pathElement
std::string getGenericDataProblem() const
return a string with the current data set problem (by default empty, can be reimplemented in children...
const RGBColor & getColor() const
get edge data color
Definition: GNEEdgeData.cpp:58
void updateGeometry()
update pre-computed geometry information
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
GNEEdgeData(GNEDataInterval *dataIntervalParent, GNEEdge *edgeParent, const std::map< std::string, std::string > &parameters)
Constructor.
Definition: GNEEdgeData.cpp:48
bool isGenericDataValid() const
check if current data set is valid to be writed into XML (by default true, can be reimplemented in ch...
double getExaggeration(const GUIVisualizationSettings &s) const
return exaggeration asociated with this GLObject
void fixGenericDataProblem()
fix data set problem (by default throw an exception, has to be reimplemented in children)
Position getPositionInView() const
Returns element position in view.
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:53
An Element which don't belongs to GNENet but has influency in the simulation.
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
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