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-2020 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 /****************************************************************************/
21 // C++ TraCI client API implementation
22 /****************************************************************************/
23 #pragma once
24 #include <config.h>
25 
26 #include <vector>
27 #include <libsumo/TraCIDefs.h>
28 #include <utils/shapes/Shape.h>
29 
30 
31 // ===========================================================================
32 // class declarations
33 // ===========================================================================
34 class NamedRTree;
35 class PointOfInterest;
36 class PositionVector;
37 namespace libsumo {
38 class VariableWrapper;
39 }
40 
41 
42 // ===========================================================================
43 // class definitions
44 // ===========================================================================
49 namespace libsumo {
50 class POI {
51 public:
52  static std::string getType(const std::string& poiID);
53  static TraCIPosition getPosition(const std::string& poiID, const bool includeZ = false);
54  static TraCIColor getColor(const std::string& poiID);
55  static double getWidth(const std::string& poiID);
56  static double getHeight(const std::string& poiID);
57  static double getAngle(const std::string& poiID);
58  static std::string getImageFile(const std::string& poiID);
59 
62 
63  static void setType(const std::string& poiID, const std::string& setType);
64  static void setColor(const std::string& poiID, const TraCIColor& color);
65  static void setPosition(const std::string& poiID, double x, double y);
66  static void setWidth(const std::string& poiID, double width);
67  static void setHeight(const std::string& poiID, double height);
68  static void setAngle(const std::string& poiID, double angle);
69  static void setImageFile(const std::string& poiID, const std::string& imageFile);
70  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);
71  static bool remove(const std::string& poiID, int layer = 0);
72  static void highlight(const std::string& poiID, const TraCIColor& col = TraCIColor(255, 0, 0, 255), double size = -1, const int alphaMax = -1, const double duration = -1, const int type = 0);
73 
74 
78  static NamedRTree* getTree();
79  static void cleanup();
80 
85  static void storeShape(const std::string& id, PositionVector& shape);
86 
87  static std::shared_ptr<VariableWrapper> makeWrapper();
88 
89  static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper);
90 
91 private:
92  static PointOfInterest* getPoI(const std::string& id);
93 
94 
95 private:
98  static NamedRTree* myTree;
99 
101  POI() = delete;
102 };
103 
104 
105 }
#define LIBSUMO_ID_PARAMETER_API
Definition: TraCIDefs.h:97
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:44
A RT-tree for efficient storing of SUMO's Named objects.
Definition: NamedRTree.h:60
A point-of-interest.
A list of positions.
static const double DEFAULT_IMG_WIDTH
Definition: Shape.h:47
static const std::string DEFAULT_IMG_FILE
Definition: Shape.h:45
static const double DEFAULT_ANGLE
Definition: Shape.h:44
static const double DEFAULT_IMG_HEIGHT
Definition: Shape.h:48
static bool remove(const std::string &poiID, int layer=0)
Definition: POI.cpp:180
static void setPosition(const std::string &poiID, double x, double y)
Definition: POI.cpp:121
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:159
static void setHeight(const std::string &poiID, double height)
Definition: POI.cpp:141
static std::string getImageFile(const std::string &poiID)
Definition: POI.cpp:100
static SubscriptionResults mySubscriptionResults
Definition: POI.h:96
static NamedRTree * getTree()
Returns a tree filled with PoI instances.
Definition: POI.cpp:268
LIBSUMO_ID_PARAMETER_API static LIBSUMO_SUBSCRIPTION_API void setType(const std::string &poiID, const std::string &setType)
Definition: POI.cpp:115
static void setColor(const std::string &poiID, const TraCIColor &color)
Definition: POI.cpp:129
static void setImageFile(const std::string &poiID, const std::string &imageFile)
Definition: POI.cpp:153
POI()=delete
invalidated standard constructor
static double getWidth(const std::string &poiID)
Definition: POI.cpp:82
static double getHeight(const std::string &poiID)
Definition: POI.cpp:88
static void setWidth(const std::string &poiID, double width)
Definition: POI.cpp:135
static double getAngle(const std::string &poiID)
Definition: POI.cpp:94
static TraCIPosition getPosition(const std::string &poiID, const bool includeZ=false)
Definition: POI.cpp:76
static PointOfInterest * getPoI(const std::string &id)
Definition: POI.cpp:258
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper)
Definition: POI.cpp:301
static void setAngle(const std::string &poiID, double angle)
Definition: POI.cpp:147
static void highlight(const std::string &poiID, const TraCIColor &col=TraCIColor(255, 0, 0, 255), double size=-1, const int alphaMax=-1, const double duration=-1, const int type=0)
Definition: POI.cpp:193
static ContextSubscriptionResults myContextSubscriptionResults
Definition: POI.h:97
static std::shared_ptr< VariableWrapper > makeWrapper()
Definition: POI.cpp:295
static void cleanup()
Definition: POI.cpp:282
static void storeShape(const std::string &id, PositionVector &shape)
Saves the shape of the requested object in the given container.
Definition: POI.cpp:289
static std::string getType(const std::string &poiID)
Definition: POI.cpp:64
static TraCIColor getColor(const std::string &poiID)
Definition: POI.cpp:70
static NamedRTree * myTree
Definition: POI.h:98
std::map< std::string, TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:250
std::map< std::string, SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:251
A 3D-position.
Definition: TraCIDefs.h:141