Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNEStoppingPlace.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-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 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
33public:
46 GNEStoppingPlace(const std::string& id, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, GNELane* lane,
47 const double startPos, const double endPos, const std::string& name, bool friendlyPosition,
48 const Parameterised::Map& parameters);
49
52
57
60
63 virtual void writeAdditional(OutputDevice& device) const = 0;
64
66 bool isAdditionalValid() const;
67
69 std::string getAdditionalProblem() const;
70
74
78 virtual void updateGeometry() = 0;
79
82
84 void updateCenteringBoundary(const bool updateGrid);
85
87 void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
89
94 std::string getParentName() const;
95
100 virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
102
105 /* @brief method for getting the Attribute of an XML key
106 * @param[in] key The attribute key
107 * @return string with the value associated to key
108 */
109 virtual std::string getAttribute(SumoXMLAttr key) const = 0;
110
111 /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
112 * @param[in] key The attribute key
113 * @return double with the value associated to key
114 */
115 virtual double getAttributeDouble(SumoXMLAttr key) const;
116
119
120 /* @brief method for setting the attribute and letting the object perform additional changes
121 * @param[in] key The attribute key
122 * @param[in] value The new value
123 * @param[in] undoList The undoList on which to register changes
124 */
125 virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
126
127 /* @brief method for checking if the key and their conrrespond attribute are valids
128 * @param[in] key The attribute key
129 * @param[in] value The value associated to key key
130 * @return true if the value is valid, false in other case
131 */
132 virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
133
135 std::string getPopUpID() const;
136
138 std::string getHierarchyName() const;
140
141protected:
144
147
150
153
155 static const double myCircleWidth;
156
158 static const double myCircleWidthSquared;
159
161 static const double myCircleInWidth;
162
164 static const double myCircleInText;
165
167 void setStoppingPlaceGeometry(double movingToSide);
168
170 void drawLines(const GUIVisualizationSettings& s, const std::vector<std::string>& lines, const RGBColor& color) const;
171
173 void drawSign(const GUIVisualizationSettings& s, const double exaggeration,
174 const RGBColor& baseColor, const RGBColor& signColor, const std::string& word) const;
175
176private:
178 virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
179
182
184 double getEndGeometryPositionOverLane() const;
185
187 void setMoveShape(const GNEMoveResult& moveResult);
188
190 void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
191
193 void setPosition(const Position& pos) = delete;
194};
195
196
GUIGlObjectType
SumoXMLTag
Numbers representing SUMO-XML - element names.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belong to GNENet but has influence in the simulation.
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 (must be reimplemented in all detector children)
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
virtual bool isValid(SumoXMLAttr key, const std::string &value)=0
method for checking if the key and their correspondent 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
const Parameterised::Map & getACParametersMap() const
get parameters map
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 (must be reimplemented in all detector children)
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 (must be reimplemented in all detector chi...
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
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
write 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.
An upper class for objects with additional parameters.
std::map< std::string, std::string > Map
parameters map
A point in 2D or 3D with translation and scaling methods.
Definition Position.h:37