Eclipse SUMO - Simulation of Urban MObility
GNEBusStop.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 // Copyright (C) 2001-2024 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 busStop geometry (adapted from GUILaneWrapper)
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 #include "GNEStoppingPlace.h"
23 
24 
25 // ===========================================================================
26 // class definitions
27 // ===========================================================================
28 
33 class GNEBusStop : public GNEStoppingPlace {
34 
35 public:
37  static GNEBusStop* buildBusStop(GNENet* net);
38 
40  static GNEBusStop* buildTrainStop(GNENet* net);
41 
56  static GNEBusStop* buildBusStop(const std::string& id, GNELane* lane, GNENet* net,
57  const double startPos, const double endPos, const std::string& name, const std::vector<std::string>& lines,
58  int personCapacity, double parkingLength, const RGBColor& color, bool friendlyPosition,
59  const Parameterised::Map& parameters);
60 
75  static GNEBusStop* buildTrainStop(const std::string& id, GNELane* lane, GNENet* net,
76  const double startPos, const double endPos, const std::string& name, const std::vector<std::string>& lines,
77  int personCapacity, double parkingLength, const RGBColor& color, bool friendlyPosition,
78  const Parameterised::Map& parameters);
79 
81  ~GNEBusStop();
82 
86  void writeAdditional(OutputDevice& device) const;
87 
90 
92  void updateGeometry();
93 
95 
98 
102  void drawGL(const GUIVisualizationSettings& s) const;
104 
107 
108  /* @brief method for getting the Attribute of an XML key
109  * @param[in] key The attribute key
110  * @return string with the value associated to key
111  */
112  std::string getAttribute(SumoXMLAttr key) const;
113 
114  /* @brief method for setting the attribute and letting the object perform additional changes
115  * @param[in] key The attribute key
116  * @param[in] value The new value
117  * @param[in] undoList The undoList on which to register changes
118  */
119  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
120 
121  /* @brief method for checking if the key and their correspond attribute are valids
122  * @param[in] key The attribute key
123  * @param[in] value The value associated to key key
124  * @return true if the value is valid, false in other case
125  */
126  bool isValid(SumoXMLAttr key, const std::string& value);
127 
129 
130 protected:
132  std::vector<std::string> myLines;
133 
136 
139 
142 
143 private:
145  void setAttribute(SumoXMLAttr key, const std::string& value);
146 
148  GNEBusStop(SumoXMLTag tag, GUIGlObjectType type, GUIIcon icon, GNENet* net);
149 
167  GNEBusStop(SumoXMLTag tag, GUIGlObjectType type, GUIIcon icon, const std::string& id, GNELane* lane, GNENet* net,
168  const double startPos, const double endPos, const std::string& name, const std::vector<std::string>& lines,
169  int personCapacity, double parkingLength, const RGBColor& color, bool friendlyPosition,
170  const Parameterised::Map& parameters);
171 
173  GNEBusStop(const GNEBusStop&) = delete;
174 
176  GNEBusStop& operator=(const GNEBusStop&) = delete;
177 };
GUIGlObjectType
GUIIcon
An enumeration of icons used by the gui applications.
Definition: GUIIcons.h:33
SumoXMLTag
Numbers representing SUMO-XML - element names.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
A lane area vehicles can halt at (netedit-version)
Definition: GNEBusStop.h:33
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
Definition: GNEBusStop.cpp:287
GNEBusStop & operator=(const GNEBusStop &)=delete
Invalidated assignment operator.
RGBColor myColor
RGB color.
Definition: GNEBusStop.h:141
GNEBusStop(SumoXMLTag tag, GUIGlObjectType type, GUIIcon icon, GNENet *net)
default constructor
Definition: GNEBusStop.cpp:407
static GNEBusStop * buildTrainStop(GNENet *net)
default constructor
Definition: GNEBusStop.cpp:46
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
Definition: GNEBusStop.cpp:263
std::string getAttribute(SumoXMLAttr key) const
Definition: GNEBusStop.cpp:216
void updateGeometry()
update pre-computed geometry information
Definition: GNEBusStop.cpp:114
GNEBusStop(const GNEBusStop &)=delete
Invalidated copy constructor.
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
Definition: GNEBusStop.cpp:75
double myParkingLength
custom space for vehicles that park at this stop
Definition: GNEBusStop.h:138
std::vector< std::string > myLines
The list of lines that are assigned to this stop.
Definition: GNEBusStop.h:132
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Definition: GNEBusStop.cpp:133
~GNEBusStop()
Destructor.
Definition: GNEBusStop.cpp:71
static GNEBusStop * buildBusStop(GNENet *net)
default constructor
Definition: GNEBusStop.cpp:40
int myPersonCapacity
maximum number of persons that can wait at this stop
Definition: GNEBusStop.h:135
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45