Eclipse SUMO - Simulation of Urban MObility
GNEVaporizer.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 
23 #include "GNEAdditional.h"
24 
25 
26 // ===========================================================================
27 // class definitions
28 // ===========================================================================
33 class GNEVaporizer : public GNEAdditional {
34 
35 public:
37  GNEVaporizer(GNENet* net);
38 
47  GNEVaporizer(GNENet* net, GNEEdge* edge, SUMOTime from, SUMOTime end, const std::string& name,
48  const std::map<std::string, std::string>& parameters);
49 
51  ~GNEVaporizer();
52 
57 
60 
63  void writeAdditional(OutputDevice& device) const;
64 
66  void updateGeometry();
67 
70 
72  void updateCenteringBoundary(const bool updateGrid);
73 
75  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
77 
82  std::string getParentName() const;
83 
88  void drawGL(const GUIVisualizationSettings& s) const;
90 
93  /* @brief method for getting the Attribute of an XML key
94  * @param[in] key The attribute key
95  * @return string with the value associated to key
96  */
97  std::string getAttribute(SumoXMLAttr key) const;
98 
99  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
100  * @param[in] key The attribute key
101  * @return double with the value associated to key
102  */
103  double getAttributeDouble(SumoXMLAttr key) const;
104 
105  /* @brief method for setting the attribute and letting the object perform additional changes
106  * @param[in] key The attribute key
107  * @param[in] value The new value
108  * @param[in] undoList The undoList on which to register changes
109  */
110  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
111 
112  /* @brief method for checking if the key and their correspond attribute are valids
113  * @param[in] key The attribute key
114  * @param[in] value The value asociated to key key
115  * @return true if the value is valid, false in other case
116  */
117  bool isValid(SumoXMLAttr key, const std::string& value);
118 
119  /* @brief method for check if the value for certain attribute is set
120  * @param[in] key The attribute key
121  */
122  bool isAttributeEnabled(SumoXMLAttr key) const;
123 
125  std::string getPopUpID() const;
126 
128  std::string getHierarchyName() const;
130 
131 protected:
134 
137 
138 private:
140  void setAttribute(SumoXMLAttr key, const std::string& value);
141 
143  void setMoveShape(const GNEMoveResult& moveResult);
144 
146  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
147 
149  GNEVaporizer(const GNEVaporizer&) = delete;
150 
153 };
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 vaporizer in netedit.
Definition: GNEVaporizer.h:33
GNEVaporizer(const GNEVaporizer &)=delete
Invalidated copy constructor.
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
Position getPositionInView() const
Returns position of additional in view.
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
void writeAdditional(OutputDevice &device) const
writte additional element into a xml file
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
std::string getAttribute(SumoXMLAttr key) const
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
GNEVaporizer & operator=(const GNEVaporizer &)=delete
Invalidated assignment operator.
GNEMoveOperation * getMoveOperation()
get move operation
void updateGeometry()
update pre-computed geometry information
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
SUMOTime myBegin
begin time of vaporizer
Definition: GNEVaporizer.h:133
SUMOTime myEnd
end time in which this vaporizer is placed
Definition: GNEVaporizer.h:136
std::string getParentName() const
Returns the name of the parent object (if any)
double getAttributeDouble(SumoXMLAttr key) const
GNEVaporizer(GNENet *net)
default Constructor
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
~GNEVaporizer()
Destructor.
bool isAttributeEnabled(SumoXMLAttr key) const
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
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