Eclipse SUMO - Simulation of Urban MObility
GNEDetectorE1Instant.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 // ===========================================================================
33 
34 public:
37 
49  GNEDetectorE1Instant(const std::string& id, GNELane* lane, GNENet* net, const double pos, const std::string& filename,
50  const std::vector<std::string>& vehicleTypes, const std::string& name, const bool friendlyPos,
51  const Parameterised::Map& parameters);
52 
55 
58 
61  void writeAdditional(OutputDevice& device) const;
62 
64  bool isAdditionalValid() const;
65 
67  std::string getAdditionalProblem() const;
68 
70  void fixAdditionalProblem();
72 
76  bool isDetectorPositionFixed() const;
77 
79  GNELane* getLane() const;
81 
84 
86  void updateGeometry();
88 
91 
95  void drawGL(const GUIVisualizationSettings& s) const;
97 
100  /* @brief method for getting the Attribute of an XML key
101  * @param[in] key The attribute key
102  * @return string with the value associated to key
103  */
104  std::string getAttribute(SumoXMLAttr key) const;
105 
106  /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
107  * @param[in] key The attribute key
108  * @return double with the value associated to key
109  */
110  double getAttributeDouble(SumoXMLAttr key) const;
111 
112  /* @brief method for setting the attribute and letting the object perform additional changes
113  * @param[in] key The attribute key
114  * @param[in] value The new value
115  * @param[in] undoList The undoList on which to register changes
116  */
117  void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
118 
119  /* @brief method for checking if the key and their correspond attribute are valids
120  * @param[in] key The attribute key
121  * @param[in] value The value associated to key key
122  * @return true if the value is valid, false in other case
123  */
124  bool isValid(SumoXMLAttr key, const std::string& value);
126 
127 private:
129  void setAttribute(SumoXMLAttr key, const std::string& value);
130 
132  void setMoveShape(const GNEMoveResult& moveResult);
133 
135  void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
136 
139 
142 };
GNEDetectorE1Instant::fixAdditionalProblem
void fixAdditionalProblem()
fix additional problem
Definition: GNEDetectorE1Instant.cpp:113
GNEDetectorE1Instant::getAttributeDouble
double getAttributeDouble(SumoXMLAttr key) const
Definition: GNEDetectorE1Instant.cpp:222
GNEDetectorE1Instant::commitMoveShape
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
Definition: GNEDetectorE1Instant.cpp:348
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
GNEDetectorE1Instant::writeAdditional
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
Definition: GNEDetectorE1Instant.cpp:56
GNEDetectorE1Instant::getLane
GNELane * getLane() const
get lane
Parameterised::Map
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45
GNEDetectorE1Instant::getAttribute
std::string getAttribute(SumoXMLAttr key) const
Definition: GNEDetectorE1Instant.cpp:193
GNEDetectorE1Instant::~GNEDetectorE1Instant
~GNEDetectorE1Instant()
Destructor.
Definition: GNEDetectorE1Instant.cpp:51
GNEDetectorE1Instant::isAdditionalValid
bool isAdditionalValid() const
check if current additional is valid to be writed into XML
Definition: GNEDetectorE1Instant.cpp:80
GNEDetectorE1Instant::operator=
GNEDetectorE1Instant & operator=(const GNEDetectorE1Instant &)=delete
Invalidated assignment operator.
GNEDetectorE1Instant::updateGeometry
void updateGeometry()
update pre-computed geometry information
Definition: GNEDetectorE1Instant.cpp:125
GNEDetectorE1Instant::setAttribute
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
Definition: GNEDetectorE1Instant.cpp:233
GNEDetector
Definition: GNEDetector.h:31
GNEDetectorE1Instant::setMoveShape
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
Definition: GNEDetectorE1Instant.cpp:337
GNEDetectorE1Instant::isDetectorPositionFixed
bool isDetectorPositionFixed() const
GNEDetectorE1Instant::drawGL
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
Definition: GNEDetectorE1Instant.cpp:134
GNEDetector.h
GNEDetectorE1Instant::getAdditionalProblem
std::string getAdditionalProblem() const
return a string with the current additional problem
Definition: GNEDetectorE1Instant.cpp:91
GNEDetectorE1Instant::GNEDetectorE1Instant
GNEDetectorE1Instant(GNENet *net)
default Constructor
Definition: GNEDetectorE1Instant.cpp:34
config.h
GNEDetectorE1Instant
Definition: GNEDetectorE1Instant.h:32
GNEUndoList
Definition: GNEUndoList.h:42
GNEDetectorE1Instant::isValid
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
Definition: GNEDetectorE1Instant.cpp:255
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