Eclipse SUMO - Simulation of Urban MObility
GNECalibrator.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#include "GNEAdditional.h"
23
24// ===========================================================================
25// class declaration
26// ===========================================================================
27
28class GNERouteProbe;
30class GNERoute;
31
32// ===========================================================================
33// class definitions
34// ===========================================================================
40
41public:
44
57 GNECalibrator(const std::string& id, GNENet* net, GNEEdge* edge, double pos, SUMOTime frequency, const std::string& name, const std::string& output,
58 const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
59
73 GNECalibrator(const std::string& id, GNENet* net, GNEEdge* edge, double pos, SUMOTime frequency, const std::string& name, const std::string& output,
74 GNEAdditional* routeProbe, const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
75
88 GNECalibrator(const std::string& id, GNENet* net, GNELane* lane, double pos, SUMOTime frequency, const std::string& name, const std::string& output,
89 const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
90
104 GNECalibrator(const std::string& id, GNENet* net, GNELane* lane, double pos, SUMOTime frequency, const std::string& name, const std::string& output,
105 GNEAdditional* routeProbe, const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
106
109
113 void writeAdditional(OutputDevice& device) const;
114
119
122
126 void updateGeometry();
127
130
132 void updateCenteringBoundary(const bool updateGrid);
133
135 void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
137
140
143 std::string getParentName() const;
144
149 void drawGL(const GUIVisualizationSettings& s) const;
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
168
169 /* @brief method for setting the attribute and letting the object perform additional changes
170 * @param[in] key The attribute key
171 * @param[in] value The new value
172 * @param[in] undoList The undoList on which to register changes
173 */
174 void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
175
176 /* @brief method for checking if the key and their correspond attribute are valids
177 * @param[in] key The attribute key
178 * @param[in] value The value associated to key key
179 * @return true if the value is valid, false in other case
180 */
181 bool isValid(SumoXMLAttr key, const std::string& value);
182
184 std::string getPopUpID() const;
185
187 std::string getHierarchyName() const;
189
190protected:
193
196
198 std::string myOutput;
199
202
204 std::vector<std::string> myVTypes;
205
207 std::vector<GUIGeometry> myEdgeCalibratorGeometries;
208
209private:
211 void drawCalibratorSymbol(const GUIVisualizationSettings& s, const double exaggeration, const Position& pos, const double rot) const;
212
214 void setAttribute(SumoXMLAttr key, const std::string& value);
215
217 void setMoveShape(const GNEMoveResult& moveResult);
218
220 void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
221
223 GNECalibrator(const GNECalibrator&) = delete;
224
227};
long long int SUMOTime
Definition: GUI.h:36
SumoXMLTag
Numbers representing SUMO-XML - element names.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belong to GNENet but has influence in the simulation.
Definition: GNEAdditional.h:48
std::string getAttribute(SumoXMLAttr key) const
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
void drawCalibratorSymbol(const GUIVisualizationSettings &s, const double exaggeration, const Position &pos, const double rot) const
draw calibrator symbol
void updateGeometry()
update pre-computed geometry information
Position getPositionInView() const
Returns position of additional in view.
const Parameterised::Map & getACParametersMap() const
get parameters map
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
GNECalibrator & operator=(const GNECalibrator &)=delete
Invalidated assignment operator.
double myJamThreshold
jamThreshold
std::string myOutput
output of calibrator
std::string getParentName() const
Returns the name of the parent object.
~GNECalibrator()
Destructor.
SUMOTime myFrequency
Frequency of calibrator.
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
double myPositionOverLane
position over Lane
std::vector< std::string > myVTypes
vTypes
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
double getAttributeDouble(SumoXMLAttr key) const
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
GNECalibrator(const GNECalibrator &)=delete
Invalidated copy constructor.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
GNECalibrator(SumoXMLTag tag, GNENet *net)
Default constructor.
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
GNEMoveOperation * getMoveOperation()
get move operation
void openAdditionalDialog()
open Calibrator Dialog
std::vector< GUIGeometry > myEdgeCalibratorGeometries
extra calibrator geometries
A road/street connecting two junctions (netedit-version)
Definition: GNEEdge.h:53
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
Representation of a RouteProbe in netedit.
Definition: GNERouteProbe.h:32
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
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