Eclipse SUMO - Simulation of Urban MObility
POI.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2012-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 /****************************************************************************/
18 // C++ TraCI client API implementation
19 /****************************************************************************/
20 #ifndef POI_h
21 #define POI_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #include <config.h>
28 
29 #include <vector>
30 #include <libsumo/TraCIDefs.h>
31 #include <utils/shapes/Shape.h>
32 
33 
34 // ===========================================================================
35 // class declarations
36 // ===========================================================================
37 class NamedRTree;
38 class PointOfInterest;
39 class PositionVector;
40 namespace libsumo {
41 class VariableWrapper;
42 }
43 
44 
45 // ===========================================================================
46 // class definitions
47 // ===========================================================================
52 namespace libsumo {
53 class POI {
54 public:
55  static std::vector<std::string> getIDList();
56  static int getIDCount();
57  static std::string getType(const std::string& poiID);
58  static TraCIPosition getPosition(const std::string& poiID, const bool includeZ = false);
59  static TraCIColor getColor(const std::string& poiID);
60  static double getWidth(const std::string& poiID);
61  static double getHeight(const std::string& poiID);
62  static double getAngle(const std::string& poiID);
63  static std::string getImageFile(const std::string& poiID);
64  static std::string getParameter(const std::string& poiID, const std::string& key);
65 
66  static void setType(const std::string& poiID, const std::string& setType);
67  static void setColor(const std::string& poiID, const TraCIColor& c);
68  static void setPosition(const std::string& poiID, double x, double y);
69  static void setWidth(const std::string& poiID, double width);
70  static void setHeight(const std::string& poiID, double height);
71  static void setAngle(const std::string& poiID, double angle);
72  static void setImageFile(const std::string& poiID, const std::string& imageFile);
73  static bool add(const std::string& poiID, double x, double y, const TraCIColor& color, const std::string& poiType = "", int layer = 0, const std::string& imgFile = Shape::DEFAULT_IMG_FILE, double width = Shape::DEFAULT_IMG_WIDTH, double height = Shape::DEFAULT_IMG_HEIGHT, double angle = Shape::DEFAULT_ANGLE);
74  static bool remove(const std::string& poiID, int layer = 0);
75  static void highlight(const std::string& poiID, const TraCIColor& col, double size, const int alphaMax, const double duration, const int type);
76 
77  static void setParameter(const std::string& poiID, const std::string& key, const std::string& value);
78 
80 
84  static NamedRTree* getTree();
85 
90  static void storeShape(const std::string& id, PositionVector& shape);
91 
92  static std::shared_ptr<VariableWrapper> makeWrapper();
93 
94  static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper);
95 
96 private:
97  static PointOfInterest* getPoI(const std::string& id);
98 
99 private:
102 
104  POI() = delete;
105 };
106 
107 
108 }
109 
110 
111 #endif
112 
113 /****************************************************************************/
libsumo::POI::getIDList
static std::vector< std::string > getIDList()
Definition: POI.cpp:50
LIBSUMO_SUBSCRIPTION_API
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:42
libsumo::POI::getWidth
static double getWidth(const std::string &poiID)
Definition: POI.cpp:83
libsumo::TraCIPosition
A 3D-position.
Definition: TraCIDefs.h:110
libsumo::POI::getPosition
static TraCIPosition getPosition(const std::string &poiID, const bool includeZ=false)
Definition: POI.cpp:77
libsumo::VariableWrapper
Definition: Subscription.h:114
libsumo::POI
Definition: POI.h:53
libsumo::ContextSubscriptionResults
std::map< std::string, SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:205
libsumo::POI::handleVariable
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper)
Definition: POI.cpp:276
libsumo::TraCIColor
A color.
Definition: TraCIDefs.h:136
PositionVector
A list of positions.
Definition: PositionVector.h:46
libsumo::POI::getHeight
static double getHeight(const std::string &poiID)
Definition: POI.cpp:89
libsumo::POI::getIDCount
static int getIDCount()
Definition: POI.cpp:59
libsumo::POI::getTree
static LIBSUMO_SUBSCRIPTION_API NamedRTree * getTree()
Returns a tree filled with PoI instances.
Definition: POI.cpp:251
libsumo::POI::makeWrapper
static std::shared_ptr< VariableWrapper > makeWrapper()
Definition: POI.cpp:270
libsumo
Definition: Edge.cpp:30
Shape::DEFAULT_IMG_HEIGHT
static const double DEFAULT_IMG_HEIGHT
Definition: Shape.h:51
libsumo::POI::setHeight
static void setHeight(const std::string &poiID, double height)
Definition: POI.cpp:139
libsumo::POI::setPosition
static void setPosition(const std::string &poiID, double x, double y)
Definition: POI.cpp:119
libsumo::POI::setAngle
static void setAngle(const std::string &poiID, double angle)
Definition: POI.cpp:145
Shape.h
libsumo::POI::getImageFile
static std::string getImageFile(const std::string &poiID)
Definition: POI.cpp:101
libsumo::POI::add
static bool add(const std::string &poiID, double x, double y, const TraCIColor &color, const std::string &poiType="", int layer=0, const std::string &imgFile=Shape::DEFAULT_IMG_FILE, double width=Shape::DEFAULT_IMG_WIDTH, double height=Shape::DEFAULT_IMG_HEIGHT, double angle=Shape::DEFAULT_ANGLE)
Definition: POI.cpp:157
libsumo::POI::getType
static std::string getType(const std::string &poiID)
Definition: POI.cpp:65
libsumo::POI::POI
POI()=delete
invalidated standard constructor
libsumo::POI::setType
static void setType(const std::string &poiID, const std::string &setType)
Definition: POI.cpp:113
libsumo::POI::getPoI
static PointOfInterest * getPoI(const std::string &id)
Definition: POI.cpp:241
libsumo::POI::getAngle
static double getAngle(const std::string &poiID)
Definition: POI.cpp:95
libsumo::POI::setWidth
static void setWidth(const std::string &poiID, double width)
Definition: POI.cpp:133
libsumo::POI::mySubscriptionResults
static SubscriptionResults mySubscriptionResults
Definition: POI.h:100
libsumo::POI::getColor
static TraCIColor getColor(const std::string &poiID)
Definition: POI.cpp:71
libsumo::POI::setColor
static void setColor(const std::string &poiID, const TraCIColor &c)
Definition: POI.cpp:127
libsumo::POI::getParameter
static std::string getParameter(const std::string &poiID, const std::string &key)
Definition: POI.cpp:107
libsumo::POI::storeShape
static void storeShape(const std::string &id, PositionVector &shape)
Saves the shape of the requested object in the given container.
Definition: POI.cpp:264
libsumo::POI::setImageFile
static void setImageFile(const std::string &poiID, const std::string &imageFile)
Definition: POI.cpp:151
NamedRTree
A RT-tree for efficient storing of SUMO's Named objects.
Definition: NamedRTree.h:64
Shape::DEFAULT_ANGLE
static const double DEFAULT_ANGLE
Definition: Shape.h:47
config.h
PointOfInterest
A point-of-interest.
Definition: PointOfInterest.h:44
Shape::DEFAULT_IMG_FILE
static const std::string DEFAULT_IMG_FILE
Definition: Shape.h:48
TraCIDefs.h
libsumo::POI::highlight
static void highlight(const std::string &poiID, const TraCIColor &col, double size, const int alphaMax, const double duration, const int type)
Definition: POI.cpp:176
libsumo::POI::setParameter
static void setParameter(const std::string &poiID, const std::string &key, const std::string &value)
Definition: POI.cpp:230
libsumo::SubscriptionResults
std::map< std::string, TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:204
libsumo::POI::myContextSubscriptionResults
static ContextSubscriptionResults myContextSubscriptionResults
Definition: POI.h:101
Shape::DEFAULT_IMG_WIDTH
static const double DEFAULT_IMG_WIDTH
Definition: Shape.h:50
libsumo::POI::remove
static bool remove(const std::string &poiID, int layer=0)
Definition: POI.cpp:169