Eclipse SUMO - Simulation of Urban MObility
GNEInstantInductionLoopDetector.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-2024 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 // ===========================================================================
33 
34 public:
37 
51  GNEInstantInductionLoopDetector(const std::string& id, GNELane* lane, GNENet* net, const double pos, const std::string& filename,
52  const std::vector<std::string>& vehicleTypes, const std::vector<std::string>& nextEdges,
53  const std::string& detectPersons, const std::string& name, const bool friendlyPos,
54  const Parameterised::Map& parameters);
55 
58 
61 
65  void writeAdditional(OutputDevice& device) const;
66 
68  bool isAdditionalValid() const;
69 
71  std::string getAdditionalProblem() const;
72 
74  void fixAdditionalProblem();
75 
77 
80 
83 
85  GNELane* getLane() const;
86 
88 
91 
93  void updateGeometry();
94 
96 
99 
104  void drawGL(const GUIVisualizationSettings& s) const;
105 
107 
110 
111  /* @brief method for getting the Attribute of an XML key
112  * @param[in] key The attribute key
113  * @return string with the value associated to key
114  */
115  std::string getAttribute(SumoXMLAttr key) const;
116 
117  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
118  * @param[in] key The attribute key
119  * @return double with the value associated to key
120  */
121  double getAttributeDouble(SumoXMLAttr key) const;
122 
123  /* @brief method for setting the attribute and letting the object perform additional changes
124  * @param[in] key The attribute key
125  * @param[in] value The new value
126  * @param[in] undoList The undoList on which to register changes
127  */
128  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
129 
130  /* @brief method for checking if the key and their correspond attribute are valids
131  * @param[in] key The attribute key
132  * @param[in] value The value associated to key key
133  * @return true if the value is valid, false in other case
134  */
135  bool isValid(SumoXMLAttr key, const std::string& value);
136 
138 
139 private:
141  void setAttribute(SumoXMLAttr key, const std::string& value);
142 
144  void setMoveShape(const GNEMoveResult& moveResult);
145 
147  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
148 
151 
154 };
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
double getAttributeDouble(SumoXMLAttr key) const
GNEInstantInductionLoopDetector(GNENet *net)
default Constructor
GNEInstantInductionLoopDetector & operator=(const GNEInstantInductionLoopDetector &)=delete
Invalidated assignment operator.
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
bool isAdditionalValid() const
check if current additional is valid to be written into XML
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
std::string getAdditionalProblem() const
return a string with the current additional problem
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
bool isDetectorPositionFixed() const
check if Position of detector is fixed
void updateGeometry()
update pre-computed geometry information
GNEInstantInductionLoopDetector(const GNEInstantInductionLoopDetector &)=delete
Invalidated copy constructor.
std::string getAttribute(SumoXMLAttr key) const
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
GNELane * getLane() const
get lane
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
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45