Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNERouteProbe.cpp
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2001-2023 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#include <config.h>
21
23#include <netedit/GNEViewNet.h>
24#include <netedit/GNEUndoList.h>
25#include <netedit/GNENet.h>
29
30#include "GNERouteProbe.h"
31
32
33// ===========================================================================
34// member method definitions
35// ===========================================================================
36
39 GUIIconSubSys::getIcon(GUIIcon::ROUTEPROBE), "", {}, {}, {}, {}, {}, {}),
40 myPeriod(SUMOTime_MAX_PERIOD),
41myBegin(0) {
42 // reset default values
43 resetDefaultValues();
44 // update centering boundary without updating grid
45 updateCenteringBoundary(false);
46}
47
48
49GNERouteProbe::GNERouteProbe(const std::string& id, GNENet* net, GNEEdge* edge, const SUMOTime period, const std::string& name,
50 const std::string& filename, SUMOTime begin, const Parameterised::Map& parameters) :
52 GUIIconSubSys::getIcon(GUIIcon::ROUTEPROBE), name, {}, {edge}, {}, {}, {}, {}),
53Parameterised(parameters),
54myPeriod(period),
55myFilename(filename),
56myBegin(begin) {
57 // update centering boundary without updating grid
58 updateCenteringBoundary(false);
59}
60
61
64
65
66void
68 // open tag
70 // write parameters
71 device.writeAttr(SUMO_ATTR_ID, getID());
73 if (getAttribute(SUMO_ATTR_PERIOD).size() > 0) {
75 }
76 device.writeAttr(SUMO_ATTR_EDGE, getParentEdges().front()->getID());
77 if (!myAdditionalName.empty()) {
79 }
80 if (!myFilename.empty()) {
82 }
83 // write parameters (Always after children to avoid problems with additionals.xsd)
84 writeParams(device);
85 device.closeTag();
86}
87
88
89bool
91 return true;
92}
93
94
95std::string
97 return "";
98}
99
100
101void
103 // nothing to fix
104}
105
106
107void
109 // calculate perpendicular line
111}
112
113
118
119
120void
121GNERouteProbe::updateCenteringBoundary(const bool /*pdateGrid*/) {
123 // add center
125 // grow
127}
128
129
130void
131GNERouteProbe::splitEdgeGeometry(const double /*splitPosition*/, const GNENetworkElement* /*originalElement*/, const GNENetworkElement* /*newElement*/, GNEUndoList* /*undoList*/) {
132 // geometry of this element cannot be splitted
133}
134
135
138 // routeprobes cannot be moved
139 return nullptr;
140}
141
142
143std::string
145 return getParentEdges().front()->getID();
146}
147
148
149void
151 // Obtain exaggeration of the draw
152 const double routeProbeExaggeration = getExaggeration(s);
153 // first check if additional has to be drawn
154 if (s.drawAdditionals(routeProbeExaggeration) && myNet->getViewNet()->getDataViewOptions().showAdditionals()) {
155 // declare colors
156 RGBColor routeProbeColor, centralLineColor;
157 // set colors
158 if (drawUsingSelectColor()) {
159 routeProbeColor = s.colorSettings.selectedAdditionalColor;
160 centralLineColor = routeProbeColor.changedBrightness(-32);
161 } else {
162 routeProbeColor = s.additionalSettings.routeProbeColor;
163 centralLineColor = RGBColor::WHITE;
164 }
165 // avoid draw invisible elements
166 if (routeProbeColor.alpha() != 0) {
167 // draw parent and child lines
169 // Start drawing adding an gl identificator
171 // Add layer matrix matrix
173 // translate to front
175 // set base color
176 GLHelper::setColor(routeProbeColor);
177 // Draw the area using shape, shapeRotations, shapeLengths and value of exaggeration
179 // move to front
180 glTranslated(0, 0, .1);
181 // set central color
182 GLHelper::setColor(centralLineColor);
183 // Draw the area using shape, shapeRotations, shapeLengths and value of exaggeration
185 // move to icon position and front
186 glTranslated(myAdditionalGeometry.getShape().front().x(), myAdditionalGeometry.getShape().front().y(), .1);
187 // rotate over lane
189 // Draw icon depending of Route Probe is selected and if isn't being drawn for selecting
190 if (!s.drawForRectangleSelection && s.drawDetail(s.detailSettings.laneTextures, routeProbeExaggeration)) {
191 // set color
192 glColor3d(1, 1, 1);
193 // rotate texture
194 glRotated(90, 0, 0, 1);
195 // draw texture
196 if (drawUsingSelectColor()) {
198 } else {
200 }
201 } else {
202 // set route probe color
203 GLHelper::setColor(routeProbeColor);
204 // just drawn a box
206 }
207 // pop layer matrix
209 // Pop name
211 }
212 // draw additional name
214 // check if mouse is over element
216 // inspect contour
219 routeProbeExaggeration, true, true);
220 }
221 // front contour
222 if (myNet->getViewNet()->getFrontAttributeCarrier() == this) {
224 routeProbeExaggeration, true, true);
225 }
226 // delete contour
227 if (myNet->getViewNet()->drawDeleteContour(this, this)) {
229 routeProbeExaggeration, true, true);
230 }
231 // delete contour
232 if (myNet->getViewNet()->drawSelectContour(this, this)) {
234 routeProbeExaggeration, true, true);
235 }
236 }
237}
238
239
240std::string
242 switch (key) {
243 case SUMO_ATTR_ID:
244 return getMicrosimID();
245 case SUMO_ATTR_EDGE:
246 return getParentEdges().front()->getID();
247 case SUMO_ATTR_NAME:
248 return myAdditionalName;
249 case SUMO_ATTR_FILE:
250 return myFilename;
251 case SUMO_ATTR_PERIOD:
254 return "";
255 } else {
256 return time2string(myPeriod);
257 }
258 case SUMO_ATTR_BEGIN:
259 return time2string(myBegin);
263 return getParametersStr();
264 default:
265 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
266 }
267}
268
269
270double
272 switch (key) {
273 case SUMO_ATTR_BEGIN:
274 return STEPS2TIME(myBegin);
275 default:
276 throw InvalidArgument(getTagStr() + " doesn't have a double attribute of type '" + toString(key) + "'");
277 }
278}
279
280
285
286
287void
288GNERouteProbe::setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) {
289 if (value == getAttribute(key)) {
290 return; //avoid needless changes, later logic relies on the fact that attributes have changed
291 }
292 switch (key) {
293 case SUMO_ATTR_ID:
294 case SUMO_ATTR_EDGE:
295 case SUMO_ATTR_NAME:
296 case SUMO_ATTR_FILE:
297 case SUMO_ATTR_PERIOD:
299 case SUMO_ATTR_BEGIN:
302 undoList->changeAttribute(new GNEChange_Attribute(this, key, value));
303 break;
304 default:
305 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
306 }
307}
308
309
310std::string
312 return getTagStr();
313}
314
315
316std::string
320
321// ===========================================================================
322// private
323// ===========================================================================
324
325bool
326GNERouteProbe::isValid(SumoXMLAttr key, const std::string& value) {
327 switch (key) {
328 case SUMO_ATTR_ID:
329 return isValidAdditionalID(value);
330 case SUMO_ATTR_EDGE:
331 if (myNet->getAttributeCarriers()->retrieveEdge(value, false) != nullptr) {
332 return true;
333 } else {
334 return false;
335 }
336 case SUMO_ATTR_NAME:
338 case SUMO_ATTR_FILE:
340 case SUMO_ATTR_PERIOD:
342 if (value.empty()) {
343 return true;
344 } else {
345 return (canParse<double>(value) && (parse<double>(value) >= 0));
346 }
347 case SUMO_ATTR_BEGIN:
348 return canParse<SUMOTime>(value);
350 return canParse<bool>(value);
352 return areParametersValid(value);
353 default:
354 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
355 }
356}
357
358
359void
360GNERouteProbe::setAttribute(SumoXMLAttr key, const std::string& value) {
361 switch (key) {
362 case SUMO_ATTR_ID:
363 // update microsimID
364 setMicrosimID(value);
365 break;
366 case SUMO_ATTR_EDGE:
368 break;
369 case SUMO_ATTR_NAME:
370 myAdditionalName = value;
371 break;
372 case SUMO_ATTR_FILE:
373 myFilename = value;
374 break;
375 case SUMO_ATTR_PERIOD:
377 if (value.empty()) {
379 } else {
380 myPeriod = string2time(value);
381 }
382 break;
383 case SUMO_ATTR_BEGIN:
384 myBegin = parse<SUMOTime>(value);
385 break;
387 if (parse<bool>(value)) {
389 } else {
391 }
392 break;
394 setParametersStr(value);
395 break;
396 default:
397 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
398 }
399}
400
401
402void
404 // nothing to do
405}
406
407
408void
409GNERouteProbe::commitMoveShape(const GNEMoveResult& /*moveResult*/, GNEUndoList* /*undoList*/) {
410 // nothing to do
411}
412
413
414/****************************************************************************/
long long int SUMOTime
Definition GUI.h:36
@ GLO_ROUTEPROBE
a RouteProbe
GUIIcon
An enumeration of icons used by the gui applications.
Definition GUIIcons.h:33
@ ROUTEPROBE_SELECTED
SUMOTime string2time(const std::string &r)
convert string to SUMOTime
Definition SUMOTime.cpp:46
std::string time2string(SUMOTime t, bool humanReadable)
convert SUMOTime to string (independently of global format setting)
Definition SUMOTime.cpp:69
#define STEPS2TIME(x)
Definition SUMOTime.h:55
#define SUMOTime_MAX_PERIOD
Definition SUMOTime.h:36
@ SUMO_TAG_ROUTEPROBE
a routeprobe detector
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
@ SUMO_ATTR_FILE
@ SUMO_ATTR_EDGE
@ GNE_ATTR_SELECTED
element is selected
@ SUMO_ATTR_BEGIN
weights: time range begin
@ GNE_ATTR_PARAMETERS
parameters "key1=value1|key2=value2|...|keyN=valueN"
@ SUMO_ATTR_NAME
@ SUMO_ATTR_PERIOD
@ SUMO_ATTR_FREQUENCY
@ SUMO_ATTR_ID
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition ToString.h:46
void add(double x, double y, double z=0)
Makes the boundary include the given coordinate.
Definition Boundary.cpp:78
void reset()
Resets the boundary.
Definition Boundary.cpp:66
Boundary & grow(double by)
extends the boundary by the given amount
Definition Boundary.cpp:300
static void setColor(const RGBColor &c)
Sets the gl-color to this value.
Definition GLHelper.cpp:583
static void pushName(unsigned int name)
push Name
Definition GLHelper.cpp:139
static void popMatrix()
pop matrix
Definition GLHelper.cpp:130
static void drawBoxLine(const Position &beg, double rot, double visLength, double width, double offset=0)
Draws a thick line.
Definition GLHelper.cpp:277
static void popName()
pop Name
Definition GLHelper.cpp:148
static void pushMatrix()
push matrix
Definition GLHelper.cpp:117
An Element which don't belong to GNENet but has influence in the simulation.
GUIGeometry myAdditionalGeometry
geometry to be precomputed in updateGeometry(...)
void replaceAdditionalParentEdges(const std::string &value)
replace additional parent edges
double getExaggeration(const GUIVisualizationSettings &s) const
return exaggeration associated with this GLObject
void calculatePerpendicularLine(const double endLaneposition)
calculate perpendicular line between lane parents
std::string myAdditionalName
name of additional
void drawAdditionalName(const GUIVisualizationSettings &s) const
draw additional name
const GUIGeometry & getAdditionalGeometry() const
obtain additional geometry
Boundary myAdditionalBoundary
Additional Boundary.
bool isValidAdditionalID(const std::string &newID) const
check if a new additional ID is valid
void drawParentChildLines(const GUIVisualizationSettings &s, const RGBColor &color, const bool onlySymbols=false) const
draw parent and child lines
const std::string getID() const
get ID (all Attribute Carriers have one)
bool isAttributeCarrierSelected() const
check if attribute carrier is selected
friend class GNEChange_Attribute
declare friend class
const std::string & getTagStr() const
get tag assigned to this object in string format
void unselectAttributeCarrier(const bool changeFlag=true)
unselect attribute carrier using GUIGlobalSelection
bool drawUsingSelectColor() const
check if attribute carrier must be drawn using selecting color.
GNENet * myNet
pointer to net
void selectAttributeCarrier(const bool changeFlag=true)
select attribute carrier using GUIGlobalSelection
A road/street connecting two junctions (netedit-version)
Definition GNEEdge.h:53
const std::vector< GNEEdge * > & getParentEdges() const
get parent edges
move operation
move result
GNEEdge * retrieveEdge(const std::string &id, bool hardFail=true) const
get edge by id
A NBNetBuilder extended by visualisation and editing capabilities.
Definition GNENet.h:42
GNENetHelper::AttributeCarriers * getAttributeCarriers() const
get all attribute carriers used in this net
Definition GNENet.cpp:120
GNEViewNet * getViewNet() const
get view net
Definition GNENet.cpp:2030
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
SUMOTime myBegin
begin of rerouter
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
Position getPositionInView() const
Returns position of additional in view.
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
std::string getParentName() const
Returns the name of the parent object.
std::string myFilename
filename of RouteProbe
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
void updateGeometry()
update pre-computed geometry information
SUMOTime myPeriod
RouteProbe period.
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
GNEMoveOperation * getMoveOperation()
get move operation
const Parameterised::Map & getACParametersMap() const
get parameters map
std::string getAdditionalProblem() const
return a string with the current additional problem (must be reimplemented in all detector children)
~GNERouteProbe()
Destructor.
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)
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
std::string getAttribute(SumoXMLAttr key) const
double getAttributeDouble(SumoXMLAttr key) const
GNERouteProbe(GNENet *net)
Constructor.
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
bool isAdditionalValid() const
check if current additional is valid to be writed into XML (must be reimplemented in all detector chi...
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
void changeAttribute(GNEChange_Attribute *change)
special method for change attributes, avoid empty changes, always execute
const GNEViewNetHelper::DataViewOptions & getDataViewOptions() const
get data view options
const GNEAttributeCarrier * getFrontAttributeCarrier() const
get front attributeCarrier
bool drawSelectContour(const GUIGlObject *GLObject, const GNEAttributeCarrier *AC) const
check if draw select contour
bool drawDeleteContour(const GUIGlObject *GLObject, const GNEAttributeCarrier *AC) const
check if draw delete contour
void drawTranslateFrontAttributeCarrier(const GNEAttributeCarrier *AC, double typeOrLayer, const double extraOffset=0)
draw front attributeCarrier
bool isAttributeCarrierInspected(const GNEAttributeCarrier *AC) const
check if attribute carrier is being inspected
static void drawDottedContourShape(const GUIVisualizationSettings &s, const DottedContourType type, const PositionVector &shape, const double width, const double exaggeration, const bool drawFirstExtrem, const bool drawLastExtrem)
draw dotted contour for the given shape (used by additionals)
static void rotateOverLane(const double rot)
rotate over lane (used by Lock icons, detector logos, etc.)
const std::vector< double > & getShapeRotations() const
The rotations of the single shape parts.
static void drawGeometry(const GUIVisualizationSettings &s, const Position &mousePos, const GUIGeometry &geometry, const double width, double offset=0)
draw geometry
const PositionVector & getShape() const
The shape of the additional element.
const std::string & getMicrosimID() const
Returns the id of the object as known to microsim.
virtual void setMicrosimID(const std::string &newID)
Changes the microsimID of the object.
bool mouseWithinGeometry(const Position center, const double radius) const
check if mouse is within elements geometry (for circles)
GUIGlID getGlID() const
Returns the numerical id of the object.
virtual Position getPositionInformation() const
Returns the cursor's x/y position within the network.
static GUIGlID getTexture(GUITexture which)
returns a texture previously defined in the enum GUITexture
static void drawTexturedBox(int which, double size)
Draws a named texture as a box with the given size.
Stores the information about how to visualize structures.
bool drawForRectangleSelection
whether drawing is performed for the purpose of selecting objects using a rectangle
GUIVisualizationDetailSettings detailSettings
detail settings
bool drawAdditionals(const double exaggeration) const
check if additionals must be drawn
GUIVisualizationColorSettings colorSettings
color settings
bool drawDetail(const double detail, const double exaggeration) const
check if details can be drawn for the given GUIVisualizationDetailSettings and current scale and exxa...
GUIVisualizationAdditionalSettings additionalSettings
Additional settings.
Static storage of an output device and its base (abstract) implementation.
OutputDevice & writeAttr(const SumoXMLAttr attr, const T &val)
writes a named attribute
OutputDevice & openTag(const std::string &xmlElement)
Opens an XML tag.
bool closeTag(const std::string &comment="")
Closes the most recently opened tag and optionally adds a comment.
An upper class for objects with additional parameters.
static bool areParametersValid(const std::string &value, bool report=false, const std::string kvsep="=", const std::string sep="|")
check if given string can be parsed to a parameters map "key1=value1|key2=value2|....
std::map< std::string, std::string > Map
parameters map
void setParametersStr(const std::string &paramsString, const std::string kvsep="=", const std::string sep="|")
set the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN"
const Parameterised::Map & getParametersMap() const
Returns the inner key/value map.
void writeParams(OutputDevice &device) const
write Params in the given outputdevice
std::string getParametersStr(const std::string kvsep="=", const std::string sep="|") const
Returns the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN".
A point in 2D or 3D with translation and scaling methods.
Definition Position.h:37
Position getPolygonCenter() const
Returns the arithmetic of all corner points.
static const RGBColor WHITE
Definition RGBColor.h:192
unsigned char alpha() const
Returns the alpha-amount of the color.
Definition RGBColor.cpp:92
RGBColor changedBrightness(int change, int toChange=3) const
Returns a new color with altered brightness.
Definition RGBColor.cpp:200
static bool isValidFilename(const std::string &value)
whether the given string is a valid attribute for a filename (for example, a name)
static bool isValidAttribute(const std::string &value)
whether the given string is a valid attribute for a certain key (for example, a name)
bool showAdditionals() const
check if additionals has to be drawn
static const double routeProbeSize
RouteProbe size.
static const RGBColor connectionColor
connection color
static const RGBColor routeProbeColor
color for route probes
RGBColor selectedAdditionalColor
additional selection color (busStops, Detectors...)
static const double laneTextures
details for lane textures