Eclipse SUMO - Simulation of Urban MObility
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
GNEVaporizer.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-2025 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// class definitions
27// ===========================================================================
28
30
31public:
33 GNEVaporizer(GNENet* net);
34
44 GNEVaporizer(GNENet* net, const std::string& filename, GNEEdge* edge, SUMOTime from, SUMOTime end,
45 const std::string& name, const Parameterised::Map& parameters);
46
49
54
57
61 void writeAdditional(OutputDevice& device) const;
62
64 bool isAdditionalValid() const;
65
67 std::string getAdditionalProblem() const;
68
71
73
76
78 bool checkDrawMoveContour() const;
79
81
84
86 void updateGeometry();
87
90
92 void updateCenteringBoundary(const bool updateGrid);
93
95 void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
96
98
101
104 std::string getParentName() const;
105
110 void drawGL(const GUIVisualizationSettings& s) const;
111
113
116
117 /* @brief method for getting the Attribute of an XML key
118 * @param[in] key The attribute key
119 * @return string with the value associated to key
120 */
121 std::string getAttribute(SumoXMLAttr key) const;
122
123 /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
124 * @param[in] key The attribute key
125 * @return double with the value associated to key
126 */
127 double getAttributeDouble(SumoXMLAttr key) const;
128
131
132 /* @brief method for setting the attribute and letting the object perform additional changes
133 * @param[in] key The attribute key
134 * @param[in] value The new value
135 * @param[in] undoList The undoList on which to register changes
136 */
137 void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
138
139 /* @brief method for checking if the key and their correspond attribute are valids
140 * @param[in] key The attribute key
141 * @param[in] value The value associated to key key
142 * @return true if the value is valid, false in other case
143 */
144 bool isValid(SumoXMLAttr key, const std::string& value);
145
147 std::string getPopUpID() const;
148
150 std::string getHierarchyName() const;
151
153
154protected:
157
160
163
164private:
166 void setAttribute(SumoXMLAttr key, const std::string& value);
167
169 void setMoveShape(const GNEMoveResult& moveResult);
170
172 void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
173
175 GNEVaporizer(const GNEVaporizer&) = delete;
176
179};
long long int SUMOTime
Definition GUI.h:36
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
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
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
write additional element into a xml file
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
bool isAdditionalValid() const
check if current additional is valid to be written into XML (must be reimplemented in all detector ch...
GNEVaporizer & operator=(const GNEVaporizer &)=delete
Invalidated assignment operator.
GNEContour mySymbolBaseContour
symbol base contour
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 correspondent attribute are valids
void fixAdditionalProblem()
fix additional problem (must be reimplemented in all detector children)
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
const Parameterised::Map & getACParametersMap() const
get parameters map
GNEMoveOperation * getMoveOperation()
get move operation
std::string getAdditionalProblem() const
return a string with the current additional problem (must be reimplemented in all detector children)
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
SUMOTime myEnd
end time in which this vaporizer is placed
std::string getParentName() const
Returns the name of the parent object.
double getAttributeDouble(SumoXMLAttr key) const
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
~GNEVaporizer()
Destructor.
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
bool checkDrawMoveContour() const
check if draw move contour (red)
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
An upper class for objects with additional parameters.
std::map< std::string, std::string > Map
parameters map
A point in 2D or 3D with translation and scaling methods.
Definition Position.h:37