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-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
14 //
15 /****************************************************************************/
16 #ifndef GNEDetectorE1_h
17 #define GNEDetectorE1_h
18 
19 
20 // ===========================================================================
21 // included modules
22 // ===========================================================================
23 
24 #include "GNEDetector.h"
25 
26 
27 // ===========================================================================
28 // class definitions
29 // ===========================================================================
34 class GNEDetectorE1 : public GNEDetector {
35 
36 public:
49  GNEDetectorE1(const std::string& id, GNELane* lane, GNEViewNet* viewNet, double pos, SUMOTime freq, const std::string& filename, const std::string& vehicleTypes, const std::string& name, bool friendlyPos, bool blockMovement);
50 
53 
57  bool isAdditionalValid() const;
58 
60  std::string getAdditionalProblem() const;
61 
63  void fixAdditionalProblem();
65 
68 
71  void moveGeometry(const Position& offset);
72 
76  void commitGeometryMoving(GNEUndoList* undoList);
77 
79  void updateGeometry();
81 
84 
88  void drawGL(const GUIVisualizationSettings& s) const;
90 
93  /* @brief method for getting the Attribute of an XML key
94  * @param[in] key The attribute key
95  * @return string with the value associated to key
96  */
97  std::string getAttribute(SumoXMLAttr key) const;
98 
99  /* @brief method for setting the attribute and letting the object perform additional changes
100  * @param[in] key The attribute key
101  * @param[in] value The new value
102  * @param[in] undoList The undoList on which to register changes
103  */
104  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
105 
106  /* @brief method for checking if the key and their correspond attribute are valids
107  * @param[in] key The attribute key
108  * @param[in] value The value asociated to key key
109  * @return true if the value is valid, false in other case
110  */
111  bool isValid(SumoXMLAttr key, const std::string& value);
112 
113  /* @brief method for check if the value for certain attribute is set
114  * @param[in] key The attribute key
115  */
116  bool isAttributeEnabled(SumoXMLAttr key) const;
118 
119 private:
121  void setAttribute(SumoXMLAttr key, const std::string& value);
122 
124  GNEDetectorE1(const GNEDetectorE1&) = delete;
125 
128 };
129 
130 #endif
131 /****************************************************************************/
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:265
GNEDetectorE1::getAdditionalProblem
std::string getAdditionalProblem() const
return a string with the current additional problem
Definition: GNEDetectorE1.cpp:61
GNEDetectorE1::GNEDetectorE1
GNEDetectorE1(const std::string &id, GNELane *lane, GNEViewNet *viewNet, double pos, SUMOTime freq, const std::string &filename, const std::string &vehicleTypes, const std::string &name, bool friendlyPos, bool blockMovement)
Constructor.
Definition: GNEDetectorE1.cpp:38
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:34
GNEViewNet
Definition: GNEViewNet.h:42
GNEDetectorE1
Definition: GNEDetectorE1.h:34
GNEDetectorE1::GNEDetectorE1
GNEDetectorE1(const GNEDetectorE1 &)=delete
Invalidated copy constructor.
GNEDetectorE1::commitGeometryMoving
void commitGeometryMoving(GNEUndoList *undoList)
commit geometry changes in the attributes of an element after use of moveGeometry(....
Definition: GNEDetectorE1.cpp:105
GNEDetectorE1::~GNEDetectorE1
~GNEDetectorE1()
Destructor.
Definition: GNEDetectorE1.cpp:45
GNEDetectorE1::isAdditionalValid
bool isAdditionalValid() const
check if current additional is valid to be writed into XML (by default true, can be reimplemented in ...
Definition: GNEDetectorE1.cpp:50
GNEDetectorE1::fixAdditionalProblem
void fixAdditionalProblem()
fix additional problem
Definition: GNEDetectorE1.cpp:77
GNEDetector
Definition: GNEDetector.h:33
Position
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:38
GNEDetectorE1::getAttribute
std::string getAttribute(SumoXMLAttr key) const
Definition: GNEDetectorE1.cpp:234
GNEDetectorE1::moveGeometry
void moveGeometry(const Position &offset)
change the position of the element geometry without saving in undoList
Definition: GNEDetectorE1.cpp:88
GNEDetectorE1::drawGL
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Definition: GNEDetectorE1.cpp:130
GNEDetector.h
GNEDetectorE1::isAttributeEnabled
bool isAttributeEnabled(SumoXMLAttr key) const
Definition: GNEDetectorE1.cpp:330
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 conrrespond attribute are valids
Definition: GNEDetectorE1.cpp:291
GNEDetectorE1::updateGeometry
void updateGeometry()
update pre-computed geometry information
Definition: GNEDetectorE1.cpp:114
GNEUndoList
Definition: GNEUndoList.h:48
GUIVisualizationSettings
Stores the information about how to visualize structures.
Definition: GUIVisualizationSettings.h:345
SumoXMLAttr
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
Definition: SUMOXMLDefinitions.h:372
GNELane
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:45