Eclipse SUMO - Simulation of Urban MObility
GNEDetectorE3.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
15 //
16 /****************************************************************************/
17 
18 // ===========================================================================
19 // included modules
20 // ===========================================================================
21 
22 #include <netedit/GNENet.h>
23 #include <netedit/GNEUndoList.h>
24 #include <netedit/GNEViewNet.h>
26 #include <utils/gui/div/GLHelper.h>
29 
30 #include "GNEDetectorE3.h"
31 
32 
33 // ===========================================================================
34 // member method definitions
35 // ===========================================================================
36 
37 GNEDetectorE3::GNEDetectorE3(const std::string& id, GNEViewNet* viewNet, Position pos, SUMOTime freq, const std::string& filename, const std::string& vehicleTypes, const std::string& name, SUMOTime timeThreshold, double speedThreshold, bool blockMovement) :
38  GNEAdditional(id, viewNet, GLO_E3DETECTOR, SUMO_TAG_E3DETECTOR, name, blockMovement, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}),
39  myPosition(pos),
40  myFreq(freq),
41  myFilename(filename),
42  myVehicleTypes(vehicleTypes),
43  myTimeThreshold(timeThreshold),
44 mySpeedThreshold(speedThreshold) {
45 }
46 
47 
49 
50 
51 void
53  // Set block icon position
55 
56  // Set block icon offset
57  myBlockIcon.offset = Position(-0.5, -0.5);
58 
59  // Set block icon rotation, and using their rotation for draw logo
61 
62  // Update connection's geometry
64 }
65 
66 
69  return myPosition;
70 }
71 
72 
75  // Return Boundary depending if myMovingGeometryBoundary is initialised (important for move geometry)
78  } else {
79  Boundary b;
80  b.add(myPosition);
81  b.grow(5);
82  return b;
83  }
84 }
85 
86 
87 void
89  // restore old position, apply offset and update Geometry
91  myPosition.add(offset);
92  // filtern position using snap to active grid
93  // filtern position using snap to active grid
96 }
97 
98 
99 void
101  // commit new position allowing undo/redo
102  undoList->p_begin("position of " + getTagStr());
104  undoList->p_end();
105 }
106 
107 
108 std::string
110  return myViewNet->getNet()->getMicrosimID();
111 }
112 
113 
114 void
116  // Obtain exaggeration of the draw
117  const double exaggeration = s.addSize.getExaggeration(s, this);
118  // check if boundary has to be drawn
119  if (s.drawBoundaries) {
121  }
122  // Start drawing adding an gl identificator
123  glPushName(getGlID());
124  // Add a draw matrix for drawing logo
125  glPushMatrix();
126  glTranslated(myPosition.x(), myPosition.y(), getType());
127  // Draw icon depending of detector is selected and if isn't being drawn for selecting
128  if (!s.drawForSelecting && s.drawDetail(s.detailSettings.laneTextures, exaggeration)) {
129  glColor3d(1, 1, 1);
130  glRotated(180, 0, 0, 1);
131  if (drawUsingSelectColor()) {
133  } else {
135  }
136  } else {
138  GLHelper::drawBoxLine(Position(0, 1), 0, 2, 1);
139  }
140  // Pop logo matrix
141  glPopMatrix();
142  // Show Lock icon depending
143  myBlockIcon.drawIcon(s, exaggeration, 0.4);
144  // Draw child connections
146  // Draw name if isn't being drawn for selecting
147  if (!s.drawForSelecting) {
149  }
150  // check if dotted contour has to be drawn
151  if (myViewNet->getDottedAC() == this) {
153  // draw shape dotte contour aroud alld connections between child and parents
154  for (auto i : myChildConnections.connectionPositions) {
156  }
157  }
158  // Pop name
159  glPopName();
160 }
161 
162 
163 std::string
165  switch (key) {
166  case SUMO_ATTR_ID:
167  return getAdditionalID();
168  case SUMO_ATTR_POSITION:
169  return toString(myPosition);
170  case SUMO_ATTR_FREQUENCY:
171  return time2string(myFreq);
172  case SUMO_ATTR_NAME:
173  return myAdditionalName;
174  case SUMO_ATTR_FILE:
175  return myFilename;
176  case SUMO_ATTR_VTYPES:
177  return myVehicleTypes;
181  return toString(mySpeedThreshold);
183  return toString(myBlockMovement);
184  case GNE_ATTR_SELECTED:
186  case GNE_ATTR_GENERIC:
187  return getGenericParametersStr();
188  default:
189  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
190  }
191 }
192 
193 
194 void
195 GNEDetectorE3::setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) {
196  if (value == getAttribute(key)) {
197  return; //avoid needless changes, later logic relies on the fact that attributes have changed
198  }
199  switch (key) {
200  case SUMO_ATTR_ID: {
201  // change ID of Entry
202  undoList->p_add(new GNEChange_Attribute(this, myViewNet->getNet(), key, value));
203  // Change Ids of all Entry/Exits children
204  for (auto i : getAdditionalChildren()) {
205  i->setAttribute(SUMO_ATTR_ID, generateChildID(i->getTagProperty().getTag()), undoList);
206  }
207  break;
208  }
209  case SUMO_ATTR_FREQUENCY:
210  case SUMO_ATTR_POSITION:
211  case SUMO_ATTR_NAME:
212  case SUMO_ATTR_FILE:
213  case SUMO_ATTR_VTYPES:
217  case GNE_ATTR_SELECTED:
218  case GNE_ATTR_GENERIC:
219  undoList->p_add(new GNEChange_Attribute(this, myViewNet->getNet(), key, value));
220  break;
221  default:
222  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
223  }
224 }
225 
226 
227 bool
228 GNEDetectorE3::isValid(SumoXMLAttr key, const std::string& value) {
229  switch (key) {
230  case SUMO_ATTR_ID:
231  return isValidDetectorID(value);
232  case SUMO_ATTR_POSITION:
233  return canParse<Position>(value);
234  case SUMO_ATTR_FREQUENCY:
235  return canParse<SUMOTime>(value);
236  case SUMO_ATTR_NAME:
238  case SUMO_ATTR_FILE:
240  case SUMO_ATTR_VTYPES:
241  if (value.empty()) {
242  return true;
243  } else {
245  }
247  return canParse<SUMOTime>(value);
249  return canParse<double>(value) && (parse<double>(value) >= 0);
251  return canParse<bool>(value);
252  case GNE_ATTR_SELECTED:
253  return canParse<bool>(value);
254  case GNE_ATTR_GENERIC:
255  return isGenericParametersValid(value);
256  default:
257  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
258  }
259 }
260 
261 
262 bool
264  int numEntrys = 0;
265  int numExits = 0;
266  // iterate over additional chidls and obtain number of entrys and exits
267  for (auto i : getAdditionalChildren()) {
268  if (i->getTagProperty().getTag() == SUMO_TAG_DET_ENTRY) {
269  numEntrys++;
270  } else if (i->getTagProperty().getTag() == SUMO_TAG_DET_EXIT) {
271  numExits++;
272  }
273  }
274  // write warnings
275  if (numEntrys == 0) {
276  WRITE_WARNING("An " + toString(SUMO_TAG_E3DETECTOR) + " need at least one " + toString(SUMO_TAG_DET_ENTRY) + " detector");
277  }
278  if (numExits == 0) {
279  WRITE_WARNING("An " + toString(SUMO_TAG_E3DETECTOR) + " need at least one " + toString(SUMO_TAG_DET_EXIT) + " detector");
280  }
281  // return false depending of number of Entrys and Exits
282  return ((numEntrys != 0) && (numExits != 0));
283 }
284 
285 
286 std::string
288  return getTagStr() + ":" + getID();
289 }
290 
291 
292 std::string
294  return getTagStr();
295 }
296 
297 
298 void
301 }
302 
303 // ===========================================================================
304 // private
305 // ===========================================================================
306 
307 void
308 GNEDetectorE3::setAttribute(SumoXMLAttr key, const std::string& value) {
309  switch (key) {
310  case SUMO_ATTR_ID:
311  changeAdditionalID(value);
312  break;
313  case SUMO_ATTR_POSITION:
315  myPosition = parse<Position>(value);
317  break;
318  case SUMO_ATTR_FREQUENCY:
319  myFreq = parse<SUMOTime>(value);
320  break;
321  case SUMO_ATTR_NAME:
322  myAdditionalName = value;
323  break;
324  case SUMO_ATTR_FILE:
325  myFilename = value;
326  break;
327  case SUMO_ATTR_VTYPES:
328  myVehicleTypes = value;
329  break;
331  myTimeThreshold = parse<SUMOTime>(value);
332  break;
334  mySpeedThreshold = parse<double>(value);
335  break;
337  myBlockMovement = parse<bool>(value);
338  break;
339  case GNE_ATTR_SELECTED:
340  if (parse<bool>(value)) {
342  } else {
344  }
345  break;
346  case GNE_ATTR_GENERIC:
348  break;
349  default:
350  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
351  }
352 }
353 
354 /****************************************************************************/
static void drawTexturedBox(int which, double size)
Draws a named texture as a box with the given size.
double mySpeedThreshold
The speed-based threshold that describes how slow a vehicle has to be to be recognized as halting...
Position snapToActiveGrid(const Position &pos, bool snapXY=true) const
Returns a position that is mapped to the closest grid point if the grid is active.
long long int SUMOTime
Definition: SUMOTime.h:35
double scale
information about a lane&#39;s width (temporary, used for a single view)
static bool isValidAttribute(const std::string &value)
whether the given string is a valid attribute for a certain key (for example, a name) ...
static bool isValidListOfTypeID(const std::string &value)
whether the given string is a valid list of ids for an edge or vehicle type (empty aren&#39;t allowed) ...
GUIVisualizationTextSettings addName
std::string getAttribute(SumoXMLAttr key) const
std::string generateChildID(SumoXMLTag childTag)
gererate a new ID for an element child
Position myPosition
position of E3 in view
SUMOTime myFreq
frequency of E3 detector
void updateAdditionalParent()
update parent after add or remove a child (can be reimplemented, for example used for statistics) ...
void add(const Position &pos)
Adds the given position to this one.
Definition: Position.h:127
void setGenericParametersStr(const std::string &value)
set generic parameters in string format
const std::string & getAdditionalID() const
std::string myVehicleTypes
attribute vehicle types
static GUIGlID getTexture(GUITexture which)
returns a texture previously defined in the enum GUITexture
Position getPositionInView() const
Returns position of additional in view.
Stores the information about how to visualize structures.
Position offset
The offSet of the block icon.
double y() const
Returns the y-position.
Definition: Position.h:62
std::string time2string(SUMOTime t)
Definition: SUMOTime.cpp:65
double x() const
Returns the x-position.
Definition: Position.h:57
GNEDetectorE3(const std::string &id, GNEViewNet *viewNet, Position pos, SUMOTime freq, const std::string &filename, const std::string &vehicleTypes, const std::string &name, SUMOTime timeThreshold, double speedThreshold, bool blockMovement)
GNEDetectorE3 Constructor.
bool drawDetail(const double detail, const double exaggeration) const
check if details can be drawn for the given GUIVisualizationDetailSettings and current scale and exxa...
void unselectAttributeCarrier(bool changeFlag=true)
unselect attribute carrier using GUIGlobalSelection
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Position position
position of the block icon
BlockIcon myBlockIcon
variable BlockIcon
Position originalViewPosition
value for saving first original position over lane before moving
void p_begin(const std::string &description)
Begin undo command sub-group. This begins a new group of commands that are treated as a single comman...
Definition: GNEUndoList.cpp:73
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
bool isAttributeCarrierSelected() const
check if attribute carrier is selected
const std::vector< GNEAdditional * > & getAdditionalChildren() const
return vector of additionals that have as Parent this edge (For example, Calibrators) ...
bool checkAdditionalChildRestriction() const
check restriction with the number of children
void changeAdditionalID(const std::string &newID)
change ID of additional
generic attribute
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:42
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:239
an e3 entry point
bool isValidDetectorID(const std::string &newID) const
check if a new detector ID is valid
void commitGeometryMoving(GNEUndoList *undoList)
commit geometry changes in the attributes of an element after use of moveGeometry(...)
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
GNEViewNet * myViewNet
The GNEViewNet this additional element belongs.
a E3 detector
AdditionalMove myMove
variable AdditionalMove
ChildConnections myChildConnections
variable ChildConnections
void p_add(GNEChange_Attribute *cmd)
special method, avoid empty changes, always execute
static void drawBoundary(const Boundary &b)
Draw a boundary (used for debugging)
Definition: GLHelper.cpp:812
GUIVisualizationSizeSettings addSize
static const RGBColor GREY
Definition: RGBColor.h:199
GUIGlObjectType getType() const
Returns the type of the object as coded in GUIGlObjectType.
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:48
static void setColor(const RGBColor &c)
Sets the gl-color to this value.
Definition: GLHelper.cpp:616
void updateGeometry()
update pre-computed geometry information
void p_end()
End undo command sub-group. If the sub-group is still empty, it will be deleted; otherwise, the sub-group will be added as a new command into parent group. A matching begin() must have been called previously.
Definition: GNEUndoList.cpp:80
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:39
an e3 exit point
std::string myAdditionalName
name of additional
static bool isGenericParametersValid(const std::string &value)
check if given string can be parsed to a map/list of generic parameters
void removeGLObjectFromGrid(GUIGlObject *o)
add GL Object into net
Definition: GNENet.cpp:1279
friend class GNEChange_Attribute
declare friend class
void selectAttributeCarrier(bool changeFlag=true)
block movement of a graphic element
Boundary getCenteringBoundary() const
Returns the boundary to which the view shall be centered in order to show the object.
static const double laneTextures
details for lane textures
void drawName(const Position &pos, const double scale, const GUIVisualizationTextSettings &settings, const double angle=0) const
draw name of item
SUMOTime myTimeThreshold
The time-based threshold that describes how much time has to pass until a vehicle is recognized as ha...
Boundary & grow(double by)
extends the boundary by the given amount
Definition: Boundary.cpp:301
virtual const std::string & getMicrosimID() const
Returns the id of the object as known to microsim.
const std::string getID() const
function to support debugging
bool myBlockMovement
boolean to check if additional element is blocked (i.e. cannot be moved with mouse) ...
static void drawShapeDottedContourAroundShape(const GUIVisualizationSettings &s, const int type, const PositionVector &shape, const double width)
draw a dotted contour around the given Non closed shape with certain width
Definition: GLHelper.cpp:461
std::string getParentName() const
Returns the name of the parent object (if any)
static void drawShapeDottedContourRectangle(const GUIVisualizationSettings &s, const int type, const Position &center, const double width, const double height, const double rotation=0, const double offsetX=0, const double offsetY=0)
draw a dotted contour around the given Position with certain width and height
Definition: GLHelper.cpp:555
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
GUIVisualizationDetailSettings detailSettings
detail settings
std::vector< PositionVector > connectionPositions
Matrix with the Vertex&#39;s positions of connections between parents an their children.
bool drawUsingSelectColor() const
check if attribute carrier must be drawn using selecting color.
void drawChildConnections(const GUIVisualizationSettings &s, const GUIGlObjectType GLTypeParent) const
An Element which don&#39;t belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:47
const GNEAttributeCarrier * getDottedAC() const
get AttributeCarrier under cursor
Definition: GNEViewNet.cpp:939
const std::string & getTagStr() const
get tag assigned to this object in string format
Boundary movingGeometryBoundary
boundary used during moving of elements (to avoid insertion in RTREE
element is selected
bool isInitialised() const
check if Boundary is Initialised
Definition: Boundary.cpp:217
std::string getGenericParametersStr() const
return generic parameters in string format
~GNEDetectorE3()
GNEDetectorE3 Destructor.
GNENet * getNet() const
get the net object
Definition: GNEViewNet.cpp:927
GUIGlID getGlID() const
Returns the numerical id of the object.
static void drawBoxLine(const Position &beg, double rot, double visLength, double width, double offset=0)
Draws a thick line.
Definition: GLHelper.cpp:136
void moveGeometry(const Position &offset)
change the position of the element geometry without saving in undoList
void add(double x, double y, double z=0)
Makes the boundary include the given coordinate.
Definition: Boundary.cpp:79
void drawIcon(const GUIVisualizationSettings &s, const double exaggeration, const double size=0.5) const
draw lock icon
bool drawForSelecting
whether drawing is performed for the purpose of selecting objects
double getExaggeration(const GUIVisualizationSettings &s, const GUIGlObject *o, double factor=20) const
return the drawing size including exaggeration and constantSize values
void addGLObjectIntoGrid(GUIGlObject *o)
add GL Object into net
Definition: GNENet.cpp:1273
static bool isValidFilename(const std::string &value)
whether the given string is a valid attribute for a filename (for example, a name) ...
bool drawBoundaries
enable or disable draw boundaries
void setRotation(GNELane *additionalLane=nullptr)
set Rotation of block Icon (must be called in updateGeometry() function)
std::string myFilename
fielname of E3 detector
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes ...