Eclipse SUMO - Simulation of Urban MObility
GNEChargingStation.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-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 // A class for visualizing chargingStation geometry (adapted from GUILaneWrapper)
19 /****************************************************************************/
21 #include <netedit/GNENet.h>
22 #include <netedit/GNEUndoList.h>
23 #include <netedit/GNEViewNet.h>
25 #include <utils/gui/div/GLHelper.h>
29 
30 #include "GNEChargingStation.h"
31 
32 // ===========================================================================
33 // member method definitions
34 // ===========================================================================
35 
37  GNEStoppingPlace("", net, GLO_CHARGING_STATION, SUMO_TAG_CHARGING_STATION, nullptr, 0, 0, "", false, std::map<std::string, std::string>()),
38  myChargingPower(0),
39  myEfficiency(0),
40  myChargeInTransit(0),
41  myChargeDelay(0) {
42  // reset default values
44 }
45 
46 
47 GNEChargingStation::GNEChargingStation(const std::string& id, GNELane* lane, GNENet* net, const double startPos, const double endPos,
48  const std::string& name, double chargingPower, double efficiency, bool chargeInTransit, SUMOTime chargeDelay, bool friendlyPosition,
49  const std::map<std::string, std::string>& parameters) :
50  GNEStoppingPlace(id, net, GLO_CHARGING_STATION, SUMO_TAG_CHARGING_STATION, lane, startPos, endPos, name, friendlyPosition, parameters),
51  myChargingPower(chargingPower),
52  myEfficiency(efficiency),
53  myChargeInTransit(chargeInTransit),
54  myChargeDelay(chargeDelay) {
55  // update centering boundary without updating grid
57 }
58 
59 
61 
62 
63 void
65  device.openTag(getTagProperty().getTag());
66  device.writeAttr(SUMO_ATTR_ID, getID());
67  if (!myAdditionalName.empty()) {
69  }
70  device.writeAttr(SUMO_ATTR_LANE, getParentLanes().front()->getID());
73  }
76  }
77  if (myFriendlyPosition) {
78  device.writeAttr(SUMO_ATTR_FRIENDLY_POS, "true");
79  }
82  }
85  }
88  }
91  }
92  // write parameters (Always after children to avoid problems with additionals.xsd)
93  writeParams(device);
94  device.closeTag();
95 }
96 
97 
98 void
100  // Get value of option "lefthand"
101  const double offsetSign = OptionsCont::getOptions().getBool("lefthand") ? -1 : 1;
102 
103  // Update common geometry of stopping place
105 
106  // Obtain a copy of the shape
108 
109  // Move shape to side
111 
112  // Get position of the sign
113  mySignPos = tmpShape.getLineCenter();
114 }
115 
116 
117 void
119  // Obtain exaggeration of the draw
120  const double chargingStationExaggeration = getExaggeration(s);
121  // first check if additional has to be drawn
123  // check exaggeration
124  if (s.drawAdditionals(chargingStationExaggeration)) {
125  // declare colors
126  RGBColor baseColor, signColor;
127  // set colors
128  if (mySpecialColor) {
129  baseColor = *mySpecialColor;
130  signColor = baseColor.changedBrightness(-32);
131  } else if (drawUsingSelectColor()) {
133  signColor = baseColor.changedBrightness(-32);
134  } else {
135  baseColor = s.colorSettings.chargingStationColor;
137  }
138  // draw parent and child lines
140  // Start drawing adding an gl identificator
142  // Add a layer matrix
144  // translate to front
146  // set base color
147  GLHelper::setColor(baseColor);
148  // Draw the area using shape, shapeRotations, shapeLengths and value of exaggeration
150  // draw detail
151  if (s.drawDetail(s.detailSettings.stoppingPlaceDetails, chargingStationExaggeration)) {
152  // draw charging power and efficiency
153  drawLines(s, {toString(myChargingPower)}, baseColor);
154  // draw sign
155  drawSign(s, chargingStationExaggeration, baseColor, signColor, "C");
156  }
157  // draw geometry points
160  }
161  if (myEndPosition != INVALID_DOUBLE) {
163  }
164  // pop layer matrix
166  // Pop name
168  // draw lock icon
170  // check if dotted contours has to be drawn
173  chargingStationExaggeration, true, true);
174  }
175  if (myNet->getViewNet()->getFrontAttributeCarrier() == this) {
177  chargingStationExaggeration, true, true);
178  }
179  // draw child demand elements
180  for (const auto& demandElement : getChildDemandElements()) {
181  if (!demandElement->getTagProperty().isPlacedInRTree()) {
182  demandElement->drawGL(s);
183  }
184  }
185  }
186  // Draw additional ID
187  drawAdditionalID(s);
188  // draw additional name
190  }
191 }
192 
193 
194 std::string
196  switch (key) {
197  case SUMO_ATTR_ID:
198  return getID();
199  case SUMO_ATTR_LANE:
200  return getParentLanes().front()->getID();
201  case SUMO_ATTR_STARTPOS:
203  return toString(myStartPosition);
204  } else {
205  return "";
206  }
207  case SUMO_ATTR_ENDPOS:
208  if (myEndPosition != INVALID_DOUBLE) {
209  return toString(myEndPosition);
210  } else {
211  return "";
212  }
213  case SUMO_ATTR_NAME:
214  return myAdditionalName;
218  return toString(myChargingPower);
220  return toString(myEfficiency);
222  return toString(myChargeInTransit);
224  return time2string(myChargeDelay);
225  case GNE_ATTR_SELECTED:
227  case GNE_ATTR_PARAMETERS:
228  return getParametersStr();
230  return "";
231  default:
232  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
233  }
234 }
235 
236 
237 void
238 GNEChargingStation::setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) {
239  switch (key) {
240  case SUMO_ATTR_ID:
241  case SUMO_ATTR_LANE:
242  case SUMO_ATTR_STARTPOS:
243  case SUMO_ATTR_ENDPOS:
244  case SUMO_ATTR_NAME:
250  case GNE_ATTR_SELECTED:
251  case GNE_ATTR_PARAMETERS:
253  undoList->changeAttribute(new GNEChange_Attribute(this, key, value));
254  break;
255  default:
256  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
257  }
258 }
259 
260 
261 bool
262 GNEChargingStation::isValid(SumoXMLAttr key, const std::string& value) {
263  switch (key) {
264  case SUMO_ATTR_ID:
265  return isValidAdditionalID(value);
266  case SUMO_ATTR_LANE:
267  if (myNet->getAttributeCarriers()->retrieveLane(value, false) != nullptr) {
268  return true;
269  } else {
270  return false;
271  }
272  case SUMO_ATTR_STARTPOS:
273  if (value.empty()) {
274  return true;
275  } else if (canParse<double>(value)) {
276  return SUMORouteHandler::isStopPosValid(parse<double>(value), getAttributeDouble(SUMO_ATTR_ENDPOS), getParentLanes().front()->getParentEdge()->getNBEdge()->getFinalLength(), POSITION_EPS, myFriendlyPosition);
277  } else {
278  return false;
279  }
280  case SUMO_ATTR_ENDPOS:
281  if (value.empty()) {
282  return true;
283  } else if (canParse<double>(value)) {
284  return SUMORouteHandler::isStopPosValid(getAttributeDouble(SUMO_ATTR_STARTPOS), parse<double>(value), getParentLanes().front()->getParentEdge()->getNBEdge()->getFinalLength(), POSITION_EPS, myFriendlyPosition);
285  } else {
286  return false;
287  }
288  case SUMO_ATTR_NAME:
291  return canParse<bool>(value);
293  return (canParse<double>(value) && parse<double>(value) >= 0);
295  return (canParse<double>(value) && parse<double>(value) >= 0 && parse<double>(value) <= 1);
297  return canParse<bool>(value);
299  return canParse<SUMOTime>(value);
300  case GNE_ATTR_SELECTED:
301  return canParse<bool>(value);
302  case GNE_ATTR_PARAMETERS:
303  return Parameterised::areParametersValid(value);
304  default:
305  throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
306  }
307 }
308 
309 // ===========================================================================
310 // private
311 // ===========================================================================
312 
313 void
314 GNEChargingStation::setAttribute(SumoXMLAttr key, const std::string& value) {
315  switch (key) {
316  case SUMO_ATTR_ID:
317  // update microsimID
318  setMicrosimID(value);
319  // enable save demand elements if there are stops
320  for (const auto& stop : getChildDemandElements()) {
321  if (stop->getTagProperty().isStop() || stop->getTagProperty().isStopPerson()) {
323  }
324  }
325  break;
326  case SUMO_ATTR_LANE:
328  break;
329  case SUMO_ATTR_STARTPOS:
330  if (value == "") {
332  } else {
333  myStartPosition = parse<double>(value);
334  }
335  break;
336  case SUMO_ATTR_ENDPOS:
337  if (value == "") {
339  } else {
340  myEndPosition = parse<double>(value);
341  }
342  break;
343  case SUMO_ATTR_NAME:
344  myAdditionalName = value;
345  break;
347  myFriendlyPosition = parse<bool>(value);
348  break;
350  myChargingPower = parse<double>(value);
351  break;
353  myEfficiency = parse<double>(value);
354  break;
356  myChargeInTransit = parse<bool>(value);
357  break;
359  myChargeDelay = parse<SUMOTime>(value);
360  break;
361  case GNE_ATTR_SELECTED:
362  if (parse<bool>(value)) {
364  } else {
366  }
367  break;
368  case GNE_ATTR_PARAMETERS:
369  setParametersStr(value);
370  break;
372  shiftLaneIndex();
373  break;
374  default:
375  throw InvalidArgument(getTagStr() + "attribute '" + toString(key) + "' not allowed");
376  }
377 }
378 
379 
380 /****************************************************************************/
@ GLO_CHARGING_STATION
a chargingStation
std::string time2string(SUMOTime t)
convert SUMOTime to string
Definition: SUMOTime.cpp:68
long long int SUMOTime
Definition: SUMOTime.h:32
@ SUMO_TAG_CHARGING_STATION
A Charging Station.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
@ SUMO_ATTR_STARTPOS
@ SUMO_ATTR_LANE
@ SUMO_ATTR_ENDPOS
@ GNE_ATTR_SELECTED
element is selected
@ GNE_ATTR_PARAMETERS
parameters "key1=value1|key2=value2|...|keyN=valueN"
@ SUMO_ATTR_CHARGEINTRANSIT
Allow/disallow charge in transit in Charging Stations.
@ SUMO_ATTR_NAME
@ SUMO_ATTR_CHARGINGPOWER
@ SUMO_ATTR_FRIENDLY_POS
@ SUMO_ATTR_EFFICIENCY
Eficiency of the charge in Charging Stations.
@ SUMO_ATTR_ID
@ SUMO_ATTR_CHARGEDELAY
Delay in the charge of charging stations.
@ GNE_ATTR_SHIFTLANEINDEX
shift lane index (only used by elements over lanes)
const double INVALID_DOUBLE
Definition: StdDefs.h:63
T MIN2(T a, T b)
Definition: StdDefs.h:74
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:46
static void setColor(const RGBColor &c)
Sets the gl-color to this value.
Definition: GLHelper.cpp:507
static void pushName(unsigned int name)
push Name
Definition: GLHelper.cpp:132
static void popMatrix()
pop matrix
Definition: GLHelper.cpp:123
static void popName()
pop Name
Definition: GLHelper.cpp:141
static void pushMatrix()
push matrix
Definition: GLHelper.cpp:114
static void drawRightGeometryPoint(const GNEViewNet *viewNet, const Position &pos, const double rot, const RGBColor &baseColor)
draw right geometry point
const std::string & getID() const
get ID
GUIGeometry myAdditionalGeometry
geometry to be precomputed in updateGeometry(...)
void drawAdditionalID(const GUIVisualizationSettings &s) const
draw additional ID
void replaceAdditionalParentLanes(const std::string &value)
replace additional parent lanes
void shiftLaneIndex()
shift lane index
double getExaggeration(const GUIVisualizationSettings &s) const
return exaggeration asociated with this GLObject
std::string myAdditionalName
name of additional
void drawAdditionalName(const GUIVisualizationSettings &s) const
draw additional name
const RGBColor * mySpecialColor
pointer to special color (used for drawing Additional with a certain color, mainly used for selection...
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
static void drawLeftGeometryPoint(const GNEViewNet *viewNet, const Position &pos, const double rot, const RGBColor &baseColor)
draw left geometry point
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
const GNETagProperties & getTagProperty() const
get tagProperty associated with this Attribute Carrier
void unselectAttributeCarrier(const bool changeFlag=true)
unselect attribute carrier using GUIGlobalSelection
bool drawUsingSelectColor() const
check if attribute carrier must be drawn using selecting color.
void resetDefaultValues()
reset attribute carrier to their default values
GNENet * myNet
pointer to net
void selectAttributeCarrier(const bool changeFlag=true)
select attribute carrier using GUIGlobalSelection
const GNETagProperties & myTagProperty
reference to tagProperty associated with this attribute carrier
std::string getAttribute(SumoXMLAttr key) const
~GNEChargingStation()
Destructor.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
GNEChargingStation(GNENet *net)
default Constructor of charging station
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
SUMOTime myChargeDelay
delay in the starting of charge
bool myChargeInTransit
enable or disable charge in transit
double myChargingPower
Charging power pro timestep.
void writeAdditional(OutputDevice &device) const
writte additional element into a xml file
double myEfficiency
efficiency of the charge
void updateGeometry()
update pre-computed geometry information
const std::vector< GNEDemandElement * > & getChildDemandElements() const
return child demand elements
const std::vector< GNELane * > & getParentLanes() const
get parent lanes
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
GNELane * retrieveLane(const std::string &id, bool hardFail=true, bool checkVolatileChange=false) const
get lane 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:125
void requireSaveDemandElements(bool value)
inform that demand elements has to be saved
Definition: GNENet.cpp:2058
GNEViewNet * getViewNet() const
get view net
Definition: GNENet.cpp:1964
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
virtual double getAttributeDouble(SumoXMLAttr key) const
bool myFriendlyPosition
Flag for friendly position.
void drawLines(const GUIVisualizationSettings &s, const std::vector< std::string > &lines, const RGBColor &color) const
draw lines
void setStoppingPlaceGeometry(double movingToSide)
set geometry common to all stopping places
double myEndPosition
The position this stopping place is located at (-1 means empty)
void drawSign(const GUIVisualizationSettings &s, const double exaggeration, const RGBColor &baseColor, const RGBColor &signColor, const std::string &word) const
draw sign
Position mySignPos
The position of the sign.
double myStartPosition
The relative start position this stopping place is located at (-1 means empty)
const std::string & getDefaultValue(SumoXMLAttr attr) const
return the default value of the attribute of an element
void changeAttribute(GNEChange_Attribute *change)
special method for change attributes, avoid empty changes, always execute
const GNEViewNetHelper::DataViewOptions & getDataViewOptions() const
get data view options
Definition: GNEViewNet.cpp:537
const GNEAttributeCarrier * getFrontAttributeCarrier() const
get front attributeCarrier
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 DottedContourType type, const GUIVisualizationSettings &s, const PositionVector &shape, const double width, const double exaggeration, const bool drawFirstExtrem, const bool drawLastExtrem, const double lineWidth=-1)
draw dotted contour for the given shape (used by additionals)
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.
virtual void setMicrosimID(const std::string &newID)
Changes the microsimID of the object.
GUIGlObjectType getType() const
Returns the type of the object as coded in GUIGlObjectType.
GUIGlID getGlID() const
Returns the numerical id of the object.
GUIVisualizationSettings & getVisualisationSettings() const
get visualization settings
Position getPositionInformation() const
Returns the cursor's x/y position within the network.
Stores the information about how to visualize structures.
GUIVisualizationDetailSettings detailSettings
detail settings
bool drawAdditionals(const double exaggeration) const
check if additionals must be drawn
GUIVisualizationColorSettings colorSettings
color settings
GUIVisualizationStoppingPlaceSettings stoppingPlaceSettings
StoppingPlace 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.
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:58
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
OutputDevice & openTag(const std::string &xmlElement)
Opens an XML tag.
OutputDevice & writeAttr(const SumoXMLAttr attr, const T &val)
writes a named attribute
Definition: OutputDevice.h:248
bool closeTag(const std::string &comment="")
Closes the most recently opened tag and optionally adds a comment.
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|....
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"
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 list of positions.
void move2side(double amount, double maxExtension=100)
move position vector to side using certain ammount
Position getLineCenter() const
get line center
Position getCentroid() const
Returns the centroid (closes the polygon if unclosed)
RGBColor changedBrightness(int change, int toChange=3) const
Returns a new color with altered brightness.
Definition: RGBColor.cpp:197
static bool isStopPosValid(const double startPos, const double endPos, const double laneLength, const double minLength, const bool friendlyPos)
check if start and end position of a stop is valid
static bool isValidAttribute(const std::string &value)
whether the given string is a valid attribute for a certain key (for example, a name)
static std::string escapeXML(const std::string &orig, const bool maskDoubleHyphen=false)
Replaces the standard escapes by their XML entities.
bool showAdditionals() const
check if additionals has to be drawn
static void drawLockIcon(const GNEAttributeCarrier *AC, GUIGlObjectType type, const Position viewPosition, const double exaggeration, const double size=0.5, const double offsetx=0, const double offsety=0)
draw lock icon
static const RGBColor connectionColor
connection color
RGBColor chargingStationColor
color for chargingStations
RGBColor selectedAdditionalColor
additional selection color (busStops, Detectors...)
RGBColor chargingStationColorSign
color for chargingStation sign
static const double stoppingPlaceDetails
details for stopping places
static const double stoppingPlaceSignOffset
busStop offset
static const double chargingStationWidth
chargingStation width