Eclipse SUMO - Simulation of Urban MObility
GNEDetectorE1.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 // ===========================================================================
26 // class definitions
27 // ===========================================================================
32 class GNEDetectorE1 : public GNEDetector {
33 
34 public:
36  GNEDetectorE1(GNENet* net);
37 
50  GNEDetectorE1(const std::string& id, GNELane* lane, GNENet* net, const double pos, const SUMOTime SUMOTime, const std::string& filename,
51  const std::vector<std::string>& vehicleTypes, const std::string& name, bool friendlyPos,
52  const Parameterised::Map& 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 associated 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);
114 
115 private:
117  void setAttribute(SumoXMLAttr key, const std::string& value);
118 
120  void setMoveShape(const GNEMoveResult& moveResult);
121 
123  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
124 
126  GNEDetectorE1(const GNEDetectorE1&) = delete;
127 
129  GNEDetectorE1& operator=(const GNEDetectorE1&) = delete;
130 };
GNEDetectorE1::setAttribute
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
Definition: GNEDetectorE1.cpp:242
GNEDetectorE1::commitMoveShape
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
Definition: GNEDetectorE1.cpp:370
SUMOTime
long long int SUMOTime
Definition: GUI.h:35
GNEDetectorE1::getAdditionalProblem
std::string getAdditionalProblem() const
return a string with the current additional problem
Definition: GNEDetectorE1.cpp:94
OutputDevice
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
GNENet
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
GNEMoveResult
move result
Definition: GNEMoveElement.h:179
GNEDetectorE1::setMoveShape
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
Definition: GNEDetectorE1.cpp:359
Parameterised::Map
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45
GNEDetectorE1
Definition: GNEDetectorE1.h:32
GNEDetectorE1::GNEDetectorE1
GNEDetectorE1(GNENet *net)
default constructor
Definition: GNEDetectorE1.cpp:34
GNEDetectorE1::writeAdditional
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
Definition: GNEDetectorE1.cpp:56
GNEDetectorE1::~GNEDetectorE1
~GNEDetectorE1()
Destructor.
Definition: GNEDetectorE1.cpp:51
GNEDetectorE1::isAdditionalValid
bool isAdditionalValid() const
check if current additional is valid to be writed into XML
Definition: GNEDetectorE1.cpp:83
GNEDetectorE1::fixAdditionalProblem
void fixAdditionalProblem()
fix additional problem
Definition: GNEDetectorE1.cpp:116
GNEDetector
Definition: GNEDetector.h:31
GNEDetectorE1::getAttribute
std::string getAttribute(SumoXMLAttr key) const
Definition: GNEDetectorE1.cpp:196
GNEDetectorE1::drawGL
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Definition: GNEDetectorE1.cpp:137
GNEDetector.h
GNEDetectorE1::getAttributeDouble
double getAttributeDouble(SumoXMLAttr key) const
Definition: GNEDetectorE1.cpp:231
GNEDetectorE1::operator=
GNEDetectorE1 & operator=(const GNEDetectorE1 &)=delete
Invalidated assignment operator.
GNEDetectorE1::isValid
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
Definition: GNEDetectorE1.cpp:264
config.h
GNEDetectorE1::updateGeometry
void updateGeometry()
update pre-computed geometry information
Definition: GNEDetectorE1.cpp:128
GNEUndoList
Definition: GNEUndoList.h:42
GUIVisualizationSettings
Stores the information about how to visualize structures.
Definition: GUIVisualizationSettings.h:583
SumoXMLAttr
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
Definition: SUMOXMLDefinitions.h:466
GNELane
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:46