Eclipse SUMO - Simulation of Urban MObility
GNEDataInterval.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 // A abstract class for data elements
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #include <config.h>
28 
30 
31 #include "GNEDataSet.h"
32 
33 // ===========================================================================
34 // class declarations
35 // ===========================================================================
36 
37 class GNEDataSet;
38 class GNEGenericData;
39 
40 // ===========================================================================
41 // class definitions
42 // ===========================================================================
43 
49 
50 public:
56  GNEDataInterval(GNEDataSet* dataSetParent, const double begin, const double end);
57 
60 
62  void updateGenericDataIDs();
63 
65  void updateAttributeColors();
66 
69 
71  const std::map<SumoXMLTag, GNEDataSet::AttributeColors>& getSpecificAttributeColors() const;
72 
75 
77  const GUIGlObject* getGUIGlObject() const;
78 
80  void updateGeometry();
81 
84 
87 
89  bool checkDrawFromContour() const;
90 
92  bool checkDrawToContour() const;
93 
95  bool checkDrawRelatedContour() const;
96 
98  bool checkDrawOverContour() const;
99 
101  bool checkDrawDeleteContour() const;
102 
104  bool checkDrawSelectContour() const;
105 
107  bool checkDrawMoveContour() const;
108 
110 
114  bool isDataIntervalValid() const;
115 
117  std::string getDataIntervalProblem() const;
118 
120  void fixDataIntervalProblem();
122 
124  GNEDataSet* getDataSetParent() const;
125 
128 
130  void addGenericDataChild(GNEGenericData* genericData);
131 
133  void removeGenericDataChild(GNEGenericData* genericData);
134 
136  bool hasGenericDataChild(GNEGenericData* genericData) const;
137 
139  const std::vector<GNEGenericData*>& getGenericDataChildren() const;
140 
142  bool edgeRelExists(const GNEEdge* fromEdge, const GNEEdge* toEdge) const;
143 
145  bool TAZRelExists(const GNEAdditional* TAZ) const;
146 
148  bool TAZRelExists(const GNEAdditional* fromTAZ, const GNEAdditional* toTAZ) const;
149 
151 
154  /* @brief method for getting the Attribute of an XML key
155  * @param[in] key The attribute key
156  * @return string with the value associated to key
157  */
158  std::string getAttribute(SumoXMLAttr key) const;
159 
160  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
161  * @param[in] key The attribute key
162  * @return double with the value associated to key
163  */
164  double getAttributeDouble(SumoXMLAttr key) const;
165 
171  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
172 
178  bool isValid(SumoXMLAttr key, const std::string& value);
179 
180  /* @brief method for check if the value for certain attribute is set
181  * @param[in] key The attribute key
182  */
183  bool isAttributeEnabled(SumoXMLAttr key) const;
184 
186  std::string getPopUpID() const;
187 
189  std::string getHierarchyName() const;
191 
193  const Parameterised::Map& getACParametersMap() const;
194 
195 protected:
198 
200  std::map<SumoXMLTag, GNEDataSet::AttributeColors> mySpecificAttributeColors;
201 
204 
206  double myBegin;
207 
209  double myEnd;
210 
212  std::vector<GNEGenericData*> myGenericDataChildren;
213 
214 private:
216  void setAttribute(SumoXMLAttr key, const std::string& value);
217 
220 
223 };
224 
225 /****************************************************************************/
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belong to GNENet but has influence in the simulation.
Definition: GNEAdditional.h:49
An Element which don't belong to GNENet but has influence in the simulation.
void fixDataIntervalProblem()
fix data element problem (by default throw an exception, has to be reimplemented in children)
bool isAttributeEnabled(SumoXMLAttr key) const
double myBegin
begin interval
Position getPositionInView() const
Returns element position in view.
GNEDataInterval(GNEDataSet *dataSetParent, const double begin, const double end)
Constructor.
bool checkDrawRelatedContour() const
check if draw related contour (cyan)
bool edgeRelExists(const GNEEdge *fromEdge, const GNEEdge *toEdge) const
check if there is already a edgeRel defined between two edges
GNEDataSet * myDataSetParent
GNEDataSet parent to which this data interval belongs.
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform data element changes
const Parameterised::Map & getACParametersMap() const
get parameters map
void removeGenericDataChild(GNEGenericData *genericData)
add generic data child
GNEDataInterval & operator=(const GNEDataInterval &)=delete
Invalidated assignment operator.
std::string getAttribute(SumoXMLAttr key) const
double getAttributeDouble(SumoXMLAttr key) const
GUIGlObject * getGUIGlObject()
get GUIGlObject associated with this AttributeCarrier
bool isDataIntervalValid() const
GNEDataSet * getDataSetParent() const
Returns a pointer to GNEDataSet parent.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
bool hasGenericDataChild(GNEGenericData *genericData) const
check if given generic data is child of this data interval
bool TAZRelExists(const GNEAdditional *TAZ) const
check if there is already a TAZRel defined in one TAZ
GNEDataSet::AttributeColors myAllAttributeColors
all attribute colors
bool checkDrawMoveContour() const
check if draw move contour (red)
bool checkDrawFromContour() const
check if draw from contour (green)
const std::vector< GNEGenericData * > & getGenericDataChildren() const
get generic data children
bool checkDrawToContour() const
check if draw from contour (magenta)
double myEnd
end interval
bool checkDrawOverContour() const
check if draw over contour (orange)
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
const std::map< SumoXMLTag, GNEDataSet::AttributeColors > & getSpecificAttributeColors() const
specific attribute colors
void updateGenericDataIDs()
update generic data child IDs
~GNEDataInterval()
Destructor.
std::map< SumoXMLTag, GNEDataSet::AttributeColors > mySpecificAttributeColors
specific attribute colors
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
std::string getDataIntervalProblem() const
return a string with the current data element problem (by default empty, can be reimplemented in chil...
GNEDataInterval(const GNEDataInterval &)=delete
Invalidated copy constructor.
const GNEDataSet::AttributeColors & getAllAttributeColors() const
all attribute colors
bool checkDrawSelectContour() const
check if draw select contour (blue)
std::vector< GNEGenericData * > myGenericDataChildren
vector with generic data children
void addGenericDataChild(GNEGenericData *genericData)
add generic data child
void updateGeometry()
update pre-computed geometry information
void updateAttributeColors()
update attribute colors deprecated
bool checkDrawDeleteContour() const
check if draw delete contour (pink/white)
attribute colors
Definition: GNEDataSet.h:47
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:53
An Element which don't belong to GNENet but has influence in the simulation.
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