Eclipse SUMO - Simulation of Urban MObility
GNEDetectorEntryExit.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 //
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 #include "GNEDetector.h"
23 
24 // ===========================================================================
25 // class declarations
26 // ===========================================================================
27 class GNEDetectorE3;
28 
29 // ===========================================================================
30 // class definitions
31 // ===========================================================================
37 
38 public:
40  GNEDetectorEntryExit(SumoXMLTag entryExitTag, GNENet* net);
41 
51  GNEDetectorEntryExit(SumoXMLTag entryExitTag, GNENet* net, GNEAdditional* parent, GNELane* lane, const double pos, const bool friendlyPos,
52  const std::map<std::string, std::string>& parameters);
53 
56 
59 
62  void writeAdditional(OutputDevice& device) const;
63 
65  bool isAdditionalValid() const;
66 
68  std::string getAdditionalProblem() const;
69 
71  void fixAdditionalProblem();
73 
75  void updateGeometry();
76 
79 
83  void drawGL(const GUIVisualizationSettings& s) const;
85 
88  /* @brief method for getting the Attribute of an XML key
89  * @param[in] key The attribute key
90  * @return string with the value associated to key
91  */
92  std::string getAttribute(SumoXMLAttr key) const;
93 
94  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
95  * @param[in] key The attribute key
96  * @return double with the value associated to key
97  */
98  double getAttributeDouble(SumoXMLAttr key) const;
99 
100  /* @brief method for setting the attribute and letting the object perform additional changes
101  * @param[in] key The attribute key
102  * @param[in] value The new value
103  * @param[in] undoList The undoList on which to register changes
104  */
105  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
106 
107  /* @brief method for checking if the key and their correspond attribute are valids
108  * @param[in] key The attribute key
109  * @param[in] value The value asociated to key key
110  * @return true if the value is valid, false in other case
111  */
112  bool isValid(SumoXMLAttr key, const std::string& value);
113 
114  /* @brief method for check if the value for certain attribute is set
115  * @param[in] key The attribute key
116  */
117  bool isAttributeEnabled(SumoXMLAttr key) const;
119 
120 private:
122  void setAttribute(SumoXMLAttr key, const std::string& value);
123 
125  void setMoveShape(const GNEMoveResult& moveResult);
126 
128  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
129 
132 
135 };
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
GNEDetectorEntryExit & operator=(const GNEDetectorEntryExit &)=delete
Invalidated assignment operator.
std::string getAdditionalProblem() const
return a string with the current additional problem
bool isAttributeEnabled(SumoXMLAttr key) const
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
GNEDetectorEntryExit(SumoXMLTag entryExitTag, GNENet *net)
default Constructor
std::string getAttribute(SumoXMLAttr key) const
double getAttributeDouble(SumoXMLAttr key) const
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
bool isAdditionalValid() const
check if current additional is valid to be writed into XML
void fixAdditionalProblem()
fix additional problem
~GNEDetectorEntryExit()
destructor
GNEDetectorEntryExit(const GNEDetectorEntryExit &)=delete
Invalidated copy constructor.
void updateGeometry()
update pre-computed geometry information
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their conrrespond attribute are valids
void writeAdditional(OutputDevice &device) const
writte additional element into a xml file
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46
move result
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