SUMO - Simulation of Urban MObility
GNEDetector.h
Go to the documentation of this file.
1 /****************************************************************************/
8 /****************************************************************************/
9 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
10 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
11 /****************************************************************************/
12 //
13 // This file is part of SUMO.
14 // SUMO is free software; you can redistribute it and/or modify
15 // it under the terms of the GNU General Public License as published by
16 // the Free Software Foundation; either version 3 of the License, or
17 // (at your option) any later version.
18 //
19 /****************************************************************************/
20 #ifndef GNEDetector_h
21 #define GNEDetector_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #ifdef _MSC_VER
28 #include <windows_config.h>
29 #else
30 #include <config.h>
31 #endif
32 
33 #include "GNEAdditional.h"
34 
35 // ===========================================================================
36 // class declarations
37 // ===========================================================================
38 class GNEAdditional;
39 class GNEViewNet;
40 
41 // ===========================================================================
42 // class definitions
43 // ===========================================================================
48 class GNEDetector : public GNEAdditional {
49 public:
61  GNEDetector(const std::string& id, GNEViewNet* viewNet, SumoXMLTag tag, GNELane* lane, SUMOReal posOverLane, int freq, const std::string& filename, bool blocked = false, GNEAdditionalSet* parent = NULL);
62 
64  ~GNEDetector();
65 
67  virtual void updateGeometry() = 0;
68 
70  virtual Position getPositionInView() const = 0;
71 
77  void moveAdditional(SUMOReal posx, SUMOReal posy, GNEUndoList* undoList);
78 
83  virtual void writeAdditional(OutputDevice& device, const std::string& currentDirectory) = 0;
84 
86  GNELane* getLane() const;
87 
90  void removeLaneReference();
91 
94 
96  int getFrequency() const;
97 
99  std::string getFilename() const;
100 
105  void setPositionOverLane(SUMOReal pos);
106 
111  void setFrequency(int freq);
112 
116  void setFilename(std::string filename);
117 
119  void changeLane(GNELane* newLane);
120 
125  const std::string& getParentName() const;
126 
131  virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
133 
136  /* @brief method for getting the Attribute of an XML key
137  * @param[in] key The attribute key
138  * @return string with the value associated to key
139  */
140  virtual std::string getAttribute(SumoXMLAttr key) const = 0;
141 
142  /* @brief method for setting the attribute and letting the object perform additional changes
143  * @param[in] key The attribute key
144  * @param[in] value The new value
145  * @param[in] undoList The undoList on which to register changes
146  */
147  virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
148 
149  /* @brief method for checking if the key and their conrrespond attribute are valids
150  * @param[in] key The attribute key
151  * @param[in] value The value asociated to key key
152  * @return true if the value is valid, false in other case
153  */
154  virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
156 
157 protected:
160 
162  int myFreq;
163 
165  std::string myFilename;
166 
170  void drawDetectorIcon(const int GNELogoID, SUMOReal sizex = 0.5, SUMOReal sizey = 0.5) const;
171 
175 
176 private:
178  virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
179 
181  const Position& getPosition() const;
182 
184  void setPosition(const Position& pos);
185 };
186 
187 #endif
188 
189 /****************************************************************************/
SumoXMLTag
Numbers representing SUMO-XML - element names.
void changeLane(GNELane *newLane)
change lane of detector
void setFilename(std::string filename)
Set a new filename in detector.
Stores the information about how to visualize structures.
void setPosition(const Position &pos)
Invalidate set new position in the view.
GNEDetector(const std::string &id, GNEViewNet *viewNet, SumoXMLTag tag, GNELane *lane, SUMOReal posOverLane, int freq, const std::string &filename, bool blocked=false, GNEAdditionalSet *parent=NULL)
Constructor.
Definition: GNEDetector.cpp:66
This lane is powered by an underlying GNEEdge and basically knows how to draw itself.
Definition: GNELane.h:54
void setFrequency(int freq)
Set a new frequency in detector.
std::string getFilename() const
returns the path to the output file
virtual void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)=0
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
virtual Position getPositionInView() const =0
Returns position of additional in view.
~GNEDetector()
Destructor.
Definition: GNEDetector.cpp:75
An Element wich group additionalSet elements.
void removeLaneReference()
Remove reference to Lane of stopping place.
void setPositionOverLane(SUMOReal pos)
Set a new position of detector over lane.
GNELane * getLane() const
Returns pointer to Lane of detector.
Definition: GNEDetector.cpp:98
void drawDetectorIcon(const int GNELogoID, SUMOReal sizex=0.5, SUMOReal sizey=0.5) const
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:46
virtual void updateGeometry()=0
update pre-computed geometry information
int getFrequency() const
returns the aggregation period the values the detector collects shall be summed up.
Position myDetectorLogoOffset
The position of detector.
Definition: GNEDetector.h:173
const std::string & getParentName() const
Returns the name of the parent object (if any)
void moveAdditional(SUMOReal posx, SUMOReal posy, GNEUndoList *undoList)
change the position of the additional geometry
Definition: GNEDetector.cpp:83
std::string myFilename
The path to the output file.
Definition: GNEDetector.h:165
SUMOReal getPositionOverLane() const
Returns the position of the detector over lane.
virtual void drawGL(const GUIVisualizationSettings &s) const =0
Draws the object.
An Element which don&#39;t belongs to GNENet but has influency in the simulation.
Definition: GNEAdditional.h:63
GNELane * myLane
The lane this detector belongs.
Definition: GNEDetector.h:159
const Position & getPosition() const
Invalidate return position of additional.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:71
#define SUMOReal
Definition: config.h:213
virtual bool isValid(SumoXMLAttr key, const std::string &value)=0
virtual void writeAdditional(OutputDevice &device, const std::string &currentDirectory)=0
writte additional element into a xml file
int myFreq
The aggregation period the values the detector collects shall be summed up.
Definition: GNEDetector.h:162
virtual std::string getAttribute(SumoXMLAttr key) const =0