Eclipse SUMO - Simulation of Urban MObility
GNEStoppingPlace.h
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 abstract class to define common parameters of lane area in which vehicles can halt (GNE version)
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 #include "GNEAdditional.h"
23 
24 // ===========================================================================
25 // class definitions
26 // ===========================================================================
32 
33 public:
46  GNEStoppingPlace(const std::string& id, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, GNELane* lane, const double startPos,
47  const double endPos, const std::string& name, bool friendlyPosition, const std::map<std::string, std::string>& parameters);
48 
51 
56 
60  bool isAdditionalValid() const;
61 
63  std::string getAdditionalProblem() const;
64 
66  void fixAdditionalProblem();
68 
72  virtual void writeAdditional(OutputDevice& device) const = 0;
73 
77  virtual void updateGeometry() = 0;
78 
81 
83  void updateCenteringBoundary(const bool updateGrid);
84 
86  void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
88 
93  std::string getParentName() const;
94 
99  virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
101 
104  /* @brief method for getting the Attribute of an XML key
105  * @param[in] key The attribute key
106  * @return string with the value associated to key
107  */
108  virtual std::string getAttribute(SumoXMLAttr key) const = 0;
109 
110  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
111  * @param[in] key The attribute key
112  * @return double with the value associated to key
113  */
114  virtual double getAttributeDouble(SumoXMLAttr key) const;
115 
116  /* @brief method for setting the attribute and letting the object perform additional changes
117  * @param[in] key The attribute key
118  * @param[in] value The new value
119  * @param[in] undoList The undoList on which to register changes
120  */
121  virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
122 
123  /* @brief method for checking if the key and their conrrespond attribute are valids
124  * @param[in] key The attribute key
125  * @param[in] value The value asociated to key key
126  * @return true if the value is valid, false in other case
127  */
128  virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
129 
130  /* @brief method for check if the value for certain attribute is set
131  * @param[in] key The attribute key
132  */
133  bool isAttributeEnabled(SumoXMLAttr key) const;
134 
136  std::string getPopUpID() const;
137 
139  std::string getHierarchyName() const;
141 
142 protected:
145 
148 
151 
154 
156  static const double myCircleWidth;
157 
159  static const double myCircleWidthSquared;
160 
162  static const double myCircleInWidth;
163 
165  static const double myCircleInText;
166 
168  void setStoppingPlaceGeometry(double movingToSide);
169 
171  void drawLines(const GUIVisualizationSettings& s, const std::vector<std::string>& lines, const RGBColor& color) const;
172 
174  void drawSign(const GUIVisualizationSettings& s, const double exaggeration,
175  const RGBColor& baseColor, const RGBColor& signColor, const std::string& word) const;
176 
177 private:
179  virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
180 
182  double getStartGeometryPositionOverLane() const;
183 
185  double getEndGeometryPositionOverLane() const;
186 
188  void setMoveShape(const GNEMoveResult& moveResult);
189 
191  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
192 
194  void setPosition(const Position& pos) = delete;
195 };
196 
197 
GUIGlObjectType
SumoXMLTag
Numbers representing SUMO-XML - element names.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:48
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
void fixAdditionalProblem()
fix additional problem
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
double getStartGeometryPositionOverLane() const
get start position over lane that is applicable to the shape
GNEStoppingPlace(const std::string &id, GNENet *net, GUIGlObjectType type, SumoXMLTag tag, GNELane *lane, const double startPos, const double endPos, const std::string &name, bool friendlyPosition, const std::map< std::string, std::string > &parameters)
Constructor.
virtual bool isValid(SumoXMLAttr key, const std::string &value)=0
method for checking if the key and their conrrespond attribute are valids
virtual double getAttributeDouble(SumoXMLAttr key) const
virtual void drawGL(const GUIVisualizationSettings &s) const =0
Draws the object.
GNEMoveOperation * getMoveOperation()
get move operation
Position getPositionInView() const
Returns position of additional in view.
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
virtual void setAttribute(SumoXMLAttr key, const std::string &value)=0
set attribute after validation
static const double myCircleWidthSquared
squared circle width resolution for all stopping places
~GNEStoppingPlace()
Destructor.
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
static const double myCircleWidth
circle width resolution for all stopping places
virtual void updateGeometry()=0
update pre-computed geometry information
bool myFriendlyPosition
Flag for friendly position.
static const double myCircleInText
text inner circle width resolution for all stopping places
std::string getAdditionalProblem() const
return a string with the current additional problem
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
static const double myCircleInWidth
inner circle width resolution for all stopping places
bool isAdditionalValid() const
check if current additional is valid to be writed into XML (by default true, can be reimplemented in ...
void drawLines(const GUIVisualizationSettings &s, const std::vector< std::string > &lines, const RGBColor &color) const
draw lines
virtual void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)=0
method for setting the attribute and letting the object perform additional changes
void setStoppingPlaceGeometry(double movingToSide)
set geometry common to all stopping places
bool isAttributeEnabled(SumoXMLAttr key) const
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
void setPosition(const Position &pos)=delete
Invalidate set new position in the view.
Position mySignPos
The position of the sign.
std::string getParentName() const
Returns the name of the parent object (if any)
virtual std::string getAttribute(SumoXMLAttr key) const =0
virtual void writeAdditional(OutputDevice &device) const =0
writte additional element into a xml file
double myStartPosition
The relative start position this stopping place is located at (-1 means empty)
double getEndGeometryPositionOverLane() const
get end position over lane that is applicable to the shape
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37