Eclipse SUMO - Simulation of Urban MObility
GNECalibratorFlow.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// Flow used by GNECalibrators
19/****************************************************************************/
20#pragma once
21#include <config.h>
23
24#include "GNEAdditional.h"
25
26// ===========================================================================
27// class declaration
28// ===========================================================================
29
30class GNECalibrator;
32
33// ===========================================================================
34// class definitions
35// ===========================================================================
41
42public:
45
47 GNECalibratorFlow(GNEAdditional* calibratorParent, GNEDemandElement* vehicleType, GNEDemandElement* route);
48
50 GNECalibratorFlow(GNEAdditional* calibratorParent, GNEDemandElement* vehicleType, GNEDemandElement* route, const SUMOVehicleParameter& vehicleParameters);
51
54
58 void writeAdditional(OutputDevice& device) const;
59
64
68 void updateGeometry();
69
72
74 void updateCenteringBoundary(const bool updateGrid);
75
77 void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
79
82
85 std::string getParentName() const;
86
91 void drawGL(const GUIVisualizationSettings& s) const;
93
96 /* @brief method for getting the Attribute of an XML key
97 * @param[in] key The attribute key
98 * @return string with the value associated to key
99 */
100 std::string getAttribute(SumoXMLAttr key) const;
101
102 /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
103 * @param[in] key The attribute key
104 * @return double with the value associated to key
105 */
106 double getAttributeDouble(SumoXMLAttr key) const;
107
110
111 /* @brief method for setting the attribute and letting the object perform additional changes
112 * @param[in] key The attribute key
113 * @param[in] value The new value
114 * @param[in] undoList The undoList on which to register changes
115 * @param[in] net optionally the GNENet to inform about gui updates
116 */
117 void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
118
119 /* @brief method for setting the attribute and letting the object perform additional changes
120 * @param[in] key The attribute key
121 * @param[in] value The new value
122 * @param[in] undoList The undoList on which to register changes
123 */
124 bool isValid(SumoXMLAttr key, const std::string& value);
125
126 /* @brief method for check if the value for certain attribute is set
127 * @param[in] key The attribute key
128 */
129 bool isAttributeEnabled(SumoXMLAttr key) const;
130
132 std::string getPopUpID() const;
133
135 std::string getHierarchyName() const;
137
138private:
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 void toggleAttribute(SumoXMLAttr key, const bool value);
150
153
156};
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belong to GNENet but has influence in the simulation.
Definition: GNEAdditional.h:48
Dialog for edit calibrators.
const Parameterised::Map & getACParametersMap() const
get parameters map
double getAttributeDouble(SumoXMLAttr key) const
GNECalibratorFlow(GNENet *net)
default constructor
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
void toggleAttribute(SumoXMLAttr key, const bool value)
toggle attribute
~GNECalibratorFlow()
destructor
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
GNECalibratorFlow & operator=(const GNECalibratorFlow &)=delete
Invalidated assignment operator.
GNEMoveOperation * getMoveOperation()
get move operation
void updateGeometry()
update pre-computed geometry information
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
Position getPositionInView() const
Returns position of additional in view.
bool isAttributeEnabled(SumoXMLAttr key) const
GNECalibratorFlow(const GNECalibratorFlow &)=delete
Invalidated copy constructor.
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
std::string getParentName() const
Returns the name of the parent object.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
std::string getAttribute(SumoXMLAttr key) const
inherited from GNEAttributeCarrier
An Element which don't belong to GNENet but has influence in the simulation.
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
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
Structure representing possible vehicle parameter.