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-2020 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 "GNEAdditional.h"
22 
23 
24 // ===========================================================================
25 // class definitions
26 // ===========================================================================
31 class GNEVaporizer : public GNEAdditional {
32 
33 public:
41  GNEVaporizer(GNENet* net, GNEEdge* edge, SUMOTime begin, SUMOTime end, const std::string& name);
42 
44  ~GNEVaporizer();
45 
49  GNEMoveOperation* getMoveOperation(const double shapeOffset);
50 
54  void updateGeometry();
55 
57  void updateCenteringBoundary(const bool updateGrid);
58 
60  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
62 
67  std::string getParentName() const;
68 
73  void drawGL(const GUIVisualizationSettings& s) const;
75 
78  /* @brief method for getting the Attribute of an XML key
79  * @param[in] key The attribute key
80  * @return string with the value associated to key
81  */
82  std::string getAttribute(SumoXMLAttr key) const;
83 
84  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
85  * @param[in] key The attribute key
86  * @return double with the value associated to key
87  */
88  double getAttributeDouble(SumoXMLAttr key) const;
89 
90  /* @brief method for setting the attribute and letting the object perform additional changes
91  * @param[in] key The attribute key
92  * @param[in] value The new value
93  * @param[in] undoList The undoList on which to register changes
94  */
95  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
96 
97  /* @brief method for checking if the key and their correspond attribute are valids
98  * @param[in] key The attribute key
99  * @param[in] value The value asociated to key key
100  * @return true if the value is valid, false in other case
101  */
102  bool isValid(SumoXMLAttr key, const std::string& value);
103 
104  /* @brief method for check if the value for certain attribute is set
105  * @param[in] key The attribute key
106  */
107  bool isAttributeEnabled(SumoXMLAttr key) const;
108 
110  std::string getPopUpID() const;
111 
113  std::string getHierarchyName() const;
115 
116 protected:
119 
122 
123 private:
125  void setAttribute(SumoXMLAttr key, const std::string& value);
126 
128  void setMoveShape(const GNEMoveResult& moveResult);
129 
131  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
132 
134  GNEVaporizer(const GNEVaporizer&) = delete;
135 
138 };
long long int SUMOTime
Definition: SUMOTime.h:31
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:47
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:49
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:40
Representation of a vaporizer in netedit.
Definition: GNEVaporizer.h:31
GNEVaporizer(const GNEVaporizer &)=delete
Invalidated copy constructor.
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
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.
GNEVaporizer(GNENet *net, GNEEdge *edge, SUMOTime begin, SUMOTime end, const std::string &name)
Constructor.
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:118
SUMOTime myEnd
end time in which this vaporizer is placed
Definition: GNEVaporizer.h:121
std::string getParentName() const
Returns the name of the parent object (if any)
double getAttributeDouble(SumoXMLAttr key) const
GNEMoveOperation * getMoveOperation(const double shapeOffset)
get move operation for the given shapeOffset
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.