Eclipse 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-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 // C++ TraCI client API implementation
19 /****************************************************************************/
20 #pragma once
21 #include <vector>
22 #include <libsumo/TraCIDefs.h>
23 #include <libsumo/VehicleType.h>
24 #ifndef LIBTRACI
26 #endif
27 
28 
29 // ===========================================================================
30 // class declarations
31 // ===========================================================================
32 #ifndef LIBTRACI
33 class MSPerson;
34 struct Reservation;
35 class PositionVector;
36 #endif
37 
38 
39 // ===========================================================================
40 // class definitions
41 // ===========================================================================
46 namespace LIBSUMO_NAMESPACE {
47 class Person {
48 public:
49  static double getSpeed(const std::string& personID);
50  static libsumo::TraCIPosition getPosition(const std::string& personID, const bool includeZ = false);
51  static libsumo::TraCIPosition getPosition3D(const std::string& personID);
52  static std::string getRoadID(const std::string& personID);
53  static std::string getLaneID(const std::string& personID);
54  static std::string getTypeID(const std::string& personID);
55  static double getWaitingTime(const std::string& personID);
56  static std::string getNextEdge(const std::string& personID);
57  static std::string getVehicle(const std::string& personID);
58  static int getRemainingStages(const std::string& personID);
59  static libsumo::TraCIStage getStage(const std::string& personID, int nextStageIndex = 0);
60  static std::vector<std::string> getEdges(const std::string& personID, int nextStageIndex = 0);
61  static double getAngle(const std::string& personID);
62  static double getSlope(const std::string& personID);
63  static double getLanePosition(const std::string& personID);
64 
65  static std::vector<libsumo::TraCIReservation> getTaxiReservations(int stateFilter = 0);
66  static std::string splitTaxiReservation(std::string reservationID, const std::vector<std::string>& personIDs);
67 
70 
71  static void add(const std::string& personID, const std::string& edgeID, double pos, double depart = libsumo::DEPARTFLAG_NOW, const std::string typeID = "DEFAULT_PEDTYPE");
72  static void appendStage(const std::string& personID, const libsumo::TraCIStage& stage);
73  static void replaceStage(const std::string& personID, const int stageIndex, const libsumo::TraCIStage& stage);
74  static void appendWaitingStage(const std::string& personID, double duration, const std::string& description = "waiting", const std::string& stopID = "");
75  static void appendWalkingStage(const std::string& personID, const std::vector<std::string>& edges, double arrivalPos, double duration = -1, double speed = -1, const std::string& stopID = "");
76  static void appendDrivingStage(const std::string& personID, const std::string& toEdge, const std::string& lines, const std::string& stopID = "");
77  static void removeStage(const std::string& personID, int nextStageIndex);
78  static void rerouteTraveltime(const std::string& personID);
79  static void moveTo(const std::string& personID, const std::string& edgeID, double position);
80  static void moveToXY(const std::string& personID, const std::string& edgeID, const double x, const double y, double angle = libsumo::INVALID_DOUBLE_VALUE, const int keepRoute = 1, double matchThreshold = 100);
81  static void remove(const std::string& personID, char reason = libsumo::REMOVE_VAPORIZED);
82  static void setSpeed(const std::string& personID, double speed);
83  static void setType(const std::string& personID, const std::string& typeID);
84 
86 
88 
89 #ifdef LIBTRACI
90  static void writeStage(const libsumo::TraCIStage& stage, tcpip::Storage& content);
91 #else
92 #ifndef SWIG
97  static void storeShape(const std::string& id, PositionVector& shape);
98 
99  static std::shared_ptr<VariableWrapper> makeWrapper();
100 
101  static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper, tcpip::Storage* paramData);
102 
103 private:
104  static MSPerson* getPerson(const std::string& id);
105  static MSStage* convertTraCIStage(const TraCIStage& stage, const std::string personID);
106  static bool filterReservation(int stateFilter, const Reservation* res, std::vector<libsumo::TraCIReservation>& reservations);
107 
110  public:
113 
115  int operator()(const TraCIReservation& r1, const TraCIReservation& r2) const;
116  };
117 
118 private:
121 #endif
122 #endif
123 
124 private:
126  Person() = delete;
127 
128 };
129 
130 
131 }
#define LIBSUMO_ID_PARAMETER_API
Definition: TraCIDefs.h:108
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:56
#define LIBSUMO_VEHICLE_TYPE_GETTER
Definition: VehicleType.h:27
#define LIBSUMO_VEHICLE_TYPE_SETTER
Definition: VehicleType.h:51
int operator()(const TraCIReservation &r1, const TraCIReservation &r2) const
comparing operation for sort
static void appendDrivingStage(const std::string &personID, const std::string &toEdge, const std::string &lines, const std::string &stopID="")
static std::string splitTaxiReservation(std::string reservationID, const std::vector< std::string > &personIDs)
static std::shared_ptr< VariableWrapper > makeWrapper()
static double getSpeed(const std::string &personID)
static double getLanePosition(const std::string &personID)
static void appendStage(const std::string &personID, const libsumo::TraCIStage &stage)
static SubscriptionResults mySubscriptionResults
Definition: Person.h:119
static libsumo::TraCIPosition getPosition(const std::string &personID, const bool includeZ=false)
static double getWaitingTime(const std::string &personID)
static void removeStage(const std::string &personID, int nextStageIndex)
static void appendWaitingStage(const std::string &personID, double duration, const std::string &description="waiting", const std::string &stopID="")
static double getSlope(const std::string &personID)
static libsumo::TraCIStage getStage(const std::string &personID, int nextStageIndex=0)
static std::string getVehicle(const std::string &personID)
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.
static void appendWalkingStage(const std::string &personID, const std::vector< std::string > &edges, double arrivalPos, double duration=-1, double speed=-1, const std::string &stopID="")
LIBSUMO_ID_PARAMETER_API static LIBSUMO_VEHICLE_TYPE_GETTER void add(const std::string &personID, const std::string &edgeID, double pos, double depart=libsumo::DEPARTFLAG_NOW, const std::string typeID="DEFAULT_PEDTYPE")
static void moveTo(const std::string &personID, const std::string &edgeID, double position)
static std::string getLaneID(const std::string &personID)
static MSPerson * getPerson(const std::string &id)
static void setType(const std::string &personID, const std::string &typeID)
static double getAngle(const std::string &personID)
static std::string getRoadID(const std::string &personID)
Person()=delete
invalidated standard constructor
static int getRemainingStages(const std::string &personID)
static bool filterReservation(int stateFilter, const Reservation *res, std::vector< libsumo::TraCIReservation > &reservations)
static std::string getTypeID(const std::string &personID)
static void replaceStage(const std::string &personID, const int stageIndex, const libsumo::TraCIStage &stage)
static void rerouteTraveltime(const std::string &personID)
static std::string getNextEdge(const std::string &personID)
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper, tcpip::Storage *paramData)
static std::vector< libsumo::TraCIReservation > getTaxiReservations(int stateFilter=0)
static MSStage * convertTraCIStage(const TraCIStage &stage, const std::string personID)
static ContextSubscriptionResults myContextSubscriptionResults
Definition: Person.h:120
static libsumo::TraCIPosition getPosition3D(const std::string &personID)
static void setSpeed(const std::string &personID, double speed)
static void remove(const std::string &personID, char reason=libsumo::REMOVE_VAPORIZED)
static void moveToXY(const std::string &personID, const std::string &edgeID, const double x, const double y, double angle=libsumo::INVALID_DOUBLE_VALUE, const int keepRoute=1, double matchThreshold=100)
static std::vector< std::string > getEdges(const std::string &personID, int nextStageIndex=0)
A list of positions.
TRACI_CONST double INVALID_DOUBLE_VALUE
std::map< std::string, libsumo::SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:279
std::map< std::string, libsumo::TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:278
TRACI_CONST int DEPARTFLAG_NOW
TRACI_CONST int REMOVE_VAPORIZED
A 3D-position.
Definition: TraCIDefs.h:164