Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNEChargingStation.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// A class for visualizing chargingStation geometry (adapted from GUILaneWrapper)
19/****************************************************************************/
20#include <config.h>
21
23#include <netedit/GNENet.h>
24#include <netedit/GNEUndoList.h>
25#include <netedit/GNEViewNet.h>
31
32#include "GNEChargingStation.h"
33
34// ===========================================================================
35// member method definitions
36// ===========================================================================
37
40 nullptr, 0, 0, "", false, Parameterised::Map()),
41 myChargingPower(0),
42 myEfficiency(0),
43 myChargeInTransit(0),
44 myChargeDelay(0) {
45 // reset default values
47}
48
49
50GNEChargingStation::GNEChargingStation(const std::string& id, GNELane* lane, GNENet* net, const double startPos, const double endPos,
51 const std::string& name, double chargingPower, double efficiency, bool chargeInTransit, SUMOTime chargeDelay, bool friendlyPosition,
52 const Parameterised::Map& parameters) :
54 lane, startPos, endPos, name, friendlyPosition, parameters),
55 myChargingPower(chargingPower),
56 myEfficiency(efficiency),
57 myChargeInTransit(chargeInTransit),
58 myChargeDelay(chargeDelay) {
59 // update centering boundary without updating grid
61}
62
63
65
66
67void
100
101
102void
104 // Get value of option "lefthand"
105 const double offsetSign = OptionsCont::getOptions().getBool("lefthand") ? -1 : 1;
106
107 // Update common geometry of stopping place
109
110 // Obtain a copy of the shape
112
113 // Move shape to side
115
116 // Get position of the sign
117 mySignPos = tmpShape.getLineCenter();
118}
119
120
121void
123 // Obtain exaggeration of the draw
124 const double chargingStationExaggeration = getExaggeration(s);
125 // first check if additional has to be drawn
127 // check exaggeration
128 if (s.drawAdditionals(chargingStationExaggeration)) {
129 // declare colors
130 RGBColor baseColor, signColor;
131 // set colors
132 if (mySpecialColor) {
133 baseColor = *mySpecialColor;
134 signColor = baseColor.changedBrightness(-32);
135 } else if (drawUsingSelectColor()) {
137 signColor = baseColor.changedBrightness(-32);
138 } else {
141 }
142 // avoid draw invisible elements
143 if (baseColor.alpha() != 0) {
144 // draw parent and child lines
146 // Start drawing adding an gl identificator
148 // Add a layer matrix
150 // translate to front
152 // set base color
153 GLHelper::setColor(baseColor);
154 // Draw the area using shape, shapeRotations, shapeLengths and value of exaggeration
156 // draw detail
157 if (s.drawDetail(s.detailSettings.stoppingPlaceDetails, chargingStationExaggeration)) {
158 // draw charging power and efficiency
159 drawLines(s, {toString(myChargingPower)}, baseColor);
160 // draw sign
161 drawSign(s, chargingStationExaggeration, baseColor, signColor, "C");
162 }
163 // draw geometry points
166 }
169 }
170 // pop layer matrix
172 // Pop name
174 // draw lock icon
176 }
177 // check if mouse is over element
180 // inspect contour
183 chargingStationExaggeration, true, true);
184 }
185 // front element contour
186 if (myNet->getViewNet()->getFrontAttributeCarrier() == this) {
188 chargingStationExaggeration, true, true);
189 }
190 // delete contour
191 if (myNet->getViewNet()->drawDeleteContour(this, this)) {
193 chargingStationExaggeration, true, true);
194 }
195 // delete contour
196 if (myNet->getViewNet()->drawSelectContour(this, this)) {
198 chargingStationExaggeration, true, true);
199 }
200 // draw child demand elements
201 for (const auto& demandElement : getChildDemandElements()) {
202 if (!demandElement->getTagProperty().isPlacedInRTree()) {
203 demandElement->drawGL(s);
204 }
205 }
206 }
207 // Draw additional ID
209 // draw additional name
211 }
212}
213
214
215std::string
217 switch (key) {
218 case SUMO_ATTR_ID:
219 return getMicrosimID();
220 case SUMO_ATTR_LANE:
221 return getParentLanes().front()->getID();
225 } else {
226 return "";
227 }
228 case SUMO_ATTR_ENDPOS:
230 return toString(myEndPosition);
231 } else {
232 return "";
233 }
234 case SUMO_ATTR_NAME:
235 return myAdditionalName;
241 return toString(myEfficiency);
249 return getParametersStr();
251 return "";
252 default:
253 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
254 }
255}
256
257
258void
259GNEChargingStation::setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) {
260 switch (key) {
261 case SUMO_ATTR_ID:
262 case SUMO_ATTR_LANE:
264 case SUMO_ATTR_ENDPOS:
265 case SUMO_ATTR_NAME:
274 undoList->changeAttribute(new GNEChange_Attribute(this, key, value));
275 break;
276 default:
277 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
278 }
279}
280
281
282bool
283GNEChargingStation::isValid(SumoXMLAttr key, const std::string& value) {
284 switch (key) {
285 case SUMO_ATTR_ID:
286 return isValidAdditionalID(value);
287 case SUMO_ATTR_LANE:
288 if (myNet->getAttributeCarriers()->retrieveLane(value, false) != nullptr) {
289 return true;
290 } else {
291 return false;
292 }
294 if (value.empty()) {
295 return true;
296 } else if (canParse<double>(value)) {
297 return SUMORouteHandler::isStopPosValid(parse<double>(value), getAttributeDouble(SUMO_ATTR_ENDPOS), getParentLanes().front()->getParentEdge()->getNBEdge()->getFinalLength(), POSITION_EPS, myFriendlyPosition);
298 } else {
299 return false;
300 }
301 case SUMO_ATTR_ENDPOS:
302 if (value.empty()) {
303 return true;
304 } else if (canParse<double>(value)) {
305 return SUMORouteHandler::isStopPosValid(getAttributeDouble(SUMO_ATTR_STARTPOS), parse<double>(value), getParentLanes().front()->getParentEdge()->getNBEdge()->getFinalLength(), POSITION_EPS, myFriendlyPosition);
306 } else {
307 return false;
308 }
309 case SUMO_ATTR_NAME:
312 return canParse<bool>(value);
314 return (canParse<double>(value) && parse<double>(value) >= 0);
316 return (canParse<double>(value) && parse<double>(value) >= 0 && parse<double>(value) <= 1);
318 return canParse<bool>(value);
320 return canParse<SUMOTime>(value);
322 return canParse<bool>(value);
324 return areParametersValid(value);
325 default:
326 throw InvalidArgument(getTagStr() + " doesn't have an attribute of type '" + toString(key) + "'");
327 }
328}
329
330// ===========================================================================
331// private
332// ===========================================================================
333
334void
335GNEChargingStation::setAttribute(SumoXMLAttr key, const std::string& value) {
336 switch (key) {
337 case SUMO_ATTR_ID:
338 // update microsimID
339 setMicrosimID(value);
340 // enable save demand elements if there are stops
341 for (const auto& stop : getChildDemandElements()) {
342 if (stop->getTagProperty().isStop() || stop->getTagProperty().isStopPerson()) {
344 }
345 }
346 break;
347 case SUMO_ATTR_LANE:
349 break;
351 if (value == "") {
353 } else {
354 myStartPosition = parse<double>(value);
355 }
356 break;
357 case SUMO_ATTR_ENDPOS:
358 if (value == "") {
360 } else {
361 myEndPosition = parse<double>(value);
362 }
363 break;
364 case SUMO_ATTR_NAME:
365 myAdditionalName = value;
366 break;
368 myFriendlyPosition = parse<bool>(value);
369 break;
371 myChargingPower = parse<double>(value);
372 break;
374 myEfficiency = parse<double>(value);
375 break;
377 myChargeInTransit = parse<bool>(value);
378 break;
380 myChargeDelay = parse<SUMOTime>(value);
381 break;
383 if (parse<bool>(value)) {
385 } else {
387 }
388 break;
390 setParametersStr(value);
391 break;
394 break;
395 default:
396 throw InvalidArgument(getTagStr() + "attribute '" + toString(key) + "' not allowed");
397 }
398}
399
400
401/****************************************************************************/
long long int SUMOTime
Definition GUI.h:36
@ GLO_CHARGING_STATION
a chargingStation
GUIIcon
An enumeration of icons used by the gui applications.
Definition GUIIcons.h:33
@ CHARGINGSTATION
std::string time2string(SUMOTime t, bool humanReadable)
convert SUMOTime to string (independently of global format setting)
Definition SUMOTime.cpp:69
@ 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
invalid double
Definition StdDefs.h:64
T MIN2(T a, T b)
Definition StdDefs.h:76
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:583
static void pushName(unsigned int name)
push Name
Definition GLHelper.cpp:139
static void popMatrix()
pop matrix
Definition GLHelper.cpp:130
static void popName()
pop Name
Definition GLHelper.cpp:148
static void pushMatrix()
push matrix
Definition GLHelper.cpp:117
static void drawRightGeometryPoint(const GNEViewNet *viewNet, const Position &pos, const double rot, const RGBColor &baseColor, const bool ignoreShift=false)
draw right geometry point
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 associated 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...
static void drawLeftGeometryPoint(const GNEViewNet *viewNet, const Position &pos, const double rot, const RGBColor &baseColor, const bool ignoreShift=false)
draw left geometry point
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
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
the function-object for an editing operation (abstract base)
std::string getAttribute(SumoXMLAttr key) const
~GNEChargingStation()
Destructor.
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent 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
write 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
void requireSaveDemandElements()
inform that demand elements has to be saved
A NBNetBuilder extended by visualisation and editing capabilities.
Definition GNENet.h:42
GNENetHelper::SavingStatus * getSavingStatus() const
get saving status
Definition GNENet.cpp:126
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
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
virtual double getAttributeDouble(SumoXMLAttr key) const
static const double myCircleWidth
circle width resolution for all stopping places
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
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)
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.
GUIGlObjectType getType() const
Returns the type of the object as coded in GUIGlObjectType.
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.
const GUIVisualizationSettings & getVisualisationSettings() const
get visualization settings (read only)
virtual 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.
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"
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)
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 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