SUMO - Simulation of Urban MObility
Person.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-2018 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 /****************************************************************************/
15 // C++ TraCI client API implementation
16 /****************************************************************************/
17 #ifndef Person_h
18 #define Person_h
19 
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 #include <config.h>
25 
26 #include <vector>
27 #include <libsumo/TraCIDefs.h>
28 #include <libsumo/VehicleType.h>
30 
31 
32 // ===========================================================================
33 // class declarations
34 // ===========================================================================
35 class MSPerson;
36 class PositionVector;
37 namespace libsumo {
38 class VariableWrapper;
39 }
40 
41 
42 // ===========================================================================
43 // class definitions
44 // ===========================================================================
49 namespace libsumo {
50 class Person {
51 public:
52  static std::vector<std::string> getIDList();
53  static int getIDCount();
54  static double getSpeed(const std::string& personID);
55  static TraCIPosition getPosition(const std::string& personID, const bool includeZ = false);
56  static std::string getRoadID(const std::string& personID);
57  static std::string getTypeID(const std::string& personID);
58  static double getWaitingTime(const std::string& personID);
59  static std::string getNextEdge(const std::string& personID);
60  static std::string getVehicle(const std::string& personID);
61  static int getRemainingStages(const std::string& personID);
62  static int getStage(const std::string& personID, int nextStageIndex = 0);
63  static std::vector<std::string> getEdges(const std::string& personID, int nextStageIndex = 0);
64  static std::string getParameter(const std::string& routeID, const std::string& param);
65  static double getAngle(const std::string& personID);
66  static double getLanePosition(const std::string& personID);
67 
69 
70  static void add(const std::string& personID, const std::string& edgeID, double pos, double depart = DEPARTFLAG_NOW, const std::string typeID = "DEFAULT_PEDTYPE");
71  static void appendWaitingStage(const std::string& personID, double duration, const std::string& description = "waiting", const std::string& stopID = "");
72  static void appendWalkingStage(const std::string& personID, const std::vector<std::string>& edgeIDs, double arrivalPos, double duration = -1, double speed = -1, const std::string& stopID = "");
73  static void appendDrivingStage(const std::string& personID, const std::string& toEdge, const std::string& lines, const std::string& stopID = "");
74  static void removeStage(const std::string& personID, int nextStageIndex);
75  static void rerouteTraveltime(const std::string& personID);
76  static void moveTo(const std::string& personID, const std::string& edgeID, double position);
77  static void moveToXY(const std::string& personID, const std::string& edgeID, const double x, const double y, double angle, const int keepRouteFlag);
78  static void setParameter(const std::string& personID, const std::string& key, const std::string& value);
79  static void setSpeed(const std::string& personID, double speed);
80  static void setType(const std::string& personID, const std::string& typeID);
81 
83 
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 MSPerson* getPerson(const std::string& id);
98 
99 private:
102 
103 private:
105  Person() = delete;
106 
107 };
108 
109 
110 }
111 
112 
113 #endif
114 
115 /****************************************************************************/
#define DEPARTFLAG_NOW
std::map< std::string, TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:199
static void rerouteTraveltime(const std::string &personID)
Definition: Person.cpp:472
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:44
static void moveTo(const std::string &personID, const std::string &edgeID, double position)
Definition: Person.cpp:524
static std::vector< std::string > getEdges(const std::string &personID, int nextStageIndex=0)
Definition: Person.cpp:135
static void appendWalkingStage(const std::string &personID, const std::vector< std::string > &edgeIDs, double arrivalPos, double duration=-1, double speed=-1, const std::string &stopID="")
Definition: Person.cpp:427
static std::string getParameter(const std::string &routeID, const std::string &param)
Definition: Person.cpp:182
static void setType(const std::string &personID, const std::string &typeID)
Definition: Person.cpp:313
LIBSUMO_VEHICLE_TYPE_SETTER static LIBSUMO_SUBSCRIPTION_API void storeShape(const std::string &id, PositionVector &shape)
Saves the shape of the requested object in the given container.
Definition: Person.cpp:808
Person()=delete
invalidated standard constructor
static double getSpeed(const std::string &personID)
Definition: Person.cpp:87
static int getIDCount()
Definition: Person.cpp:69
static MSPerson * getPerson(const std::string &id)
Definition: Person.cpp:797
static int getStage(const std::string &personID, int nextStageIndex=0)
Definition: Person.cpp:152
std::map< std::string, SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:200
static void setSpeed(const std::string &personID, double speed)
Definition: Person.cpp:307
static SubscriptionResults mySubscriptionResults
Definition: Person.h:100
static LIBSUMO_VEHICLE_TYPE_GETTER void add(const std::string &personID, const std::string &edgeID, double pos, double depart=DEPARTFLAG_NOW, const std::string typeID="DEFAULT_PEDTYPE")
Definition: Person.cpp:323
#define LIBSUMO_VEHICLE_TYPE_GETTER
Definition: VehicleType.h:30
static std::string getTypeID(const std::string &personID)
Definition: Person.cpp:117
static void appendDrivingStage(const std::string &personID, const std::string &toEdge, const std::string &lines, const std::string &stopID="")
Definition: Person.cpp:389
static double getAngle(const std::string &personID)
Definition: Person.cpp:81
A list of positions.
static std::string getNextEdge(const std::string &personID)
Definition: Person.cpp:129
static ContextSubscriptionResults myContextSubscriptionResults
Definition: Person.h:101
static double getWaitingTime(const std::string &personID)
Definition: Person.cpp:123
static int getRemainingStages(const std::string &personID)
Definition: Person.cpp:165
static std::string getVehicle(const std::string &personID)
Definition: Person.cpp:171
static void removeStage(const std::string &personID, int nextStageIndex)
Definition: Person.cpp:459
static std::vector< std::string > getIDList()
Definition: Person.cpp:56
Definition: Edge.cpp:30
static void setParameter(const std::string &personID, const std::string &key, const std::string &value)
Definition: Person.cpp:666
static TraCIPosition getPosition(const std::string &personID, const bool includeZ=false)
Definition: Person.cpp:75
static void appendWaitingStage(const std::string &personID, double duration, const std::string &description="waiting", const std::string &stopID="")
Definition: Person.cpp:410
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper)
Definition: Person.cpp:820
static void moveToXY(const std::string &personID, const std::string &edgeID, const double x, const double y, double angle, const int keepRouteFlag)
Definition: Person.cpp:549
static std::shared_ptr< VariableWrapper > makeWrapper()
Definition: Person.cpp:814
A 3D-position.
Definition: TraCIDefs.h:107
static std::string getRoadID(const std::string &personID)
Definition: Person.cpp:93
static double getLanePosition(const std::string &personID)
Definition: Person.cpp:99
#define LIBSUMO_VEHICLE_TYPE_SETTER
Definition: VehicleType.h:53