Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
MSPModel.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2014-2024 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// The pedestrian following model (prototype)
19/****************************************************************************/
20#pragma once
21#include <config.h>
22
23#include <string>
24#include <limits>
30#ifdef HAVE_FOX
32#endif
33
34// ===========================================================================
35// class declarations
36// ===========================================================================
37class MSNet;
38class MSLane;
39class MSJunction;
40
41typedef std::pair<const MSPerson*, double> PersonDist;
42
43// ===========================================================================
44// class definitions
45// ===========================================================================
51class MSPModel {
52public:
53 // @brief walking directions
54 static const int FORWARD;
55 static const int BACKWARD;
56 static const int UNDEFINED_DIRECTION;
57
58 // @brief the safety gap to keep between the car and the pedestrian in all directions
59 static const double SAFETY_GAP;
60
62 static const double SIDEWALK_OFFSET;
63
65 static const double UNSPECIFIED_POS_LAT;
66
68 static const double RANDOM_POS_LAT;
69
70 virtual ~MSPModel() {};
71
73 virtual MSTransportableStateAdapter* add(MSTransportable* transportable, MSStageMoving* stage, SUMOTime now) = 0;
74
76 virtual MSTransportableStateAdapter* loadState(MSTransportable* transportable, MSStageMoving* stage, std::istringstream& state) {
77 UNUSED_PARAMETER(transportable);
78 UNUSED_PARAMETER(stage);
79 UNUSED_PARAMETER(state);
80 return nullptr;
81 }
82
84 virtual void clearState() = 0;
85
87 virtual void remove(MSTransportableStateAdapter* state) = 0;
88
98 virtual bool blockedAtDist(const SUMOTrafficObject* ego, const MSLane* lane, double vehSide, double vehWidth,
99 double oncomingGap, std::vector<const MSPerson*>* collectBlockers) {
100 UNUSED_PARAMETER(ego);
101 UNUSED_PARAMETER(lane);
102 UNUSED_PARAMETER(vehSide);
103 UNUSED_PARAMETER(vehWidth);
104 UNUSED_PARAMETER(oncomingGap);
105 UNUSED_PARAMETER(collectBlockers);
106 return false;
107 }
108
110 virtual bool hasPedestrians(const MSLane* lane) {
111 UNUSED_PARAMETER(lane);
112 return false;
113 }
114
124 virtual PersonDist nextBlocking(const MSLane* lane, double minPos, double minRight, double maxLeft, double stopTime = 0, bool bidi = false) {
125 UNUSED_PARAMETER(lane);
126 UNUSED_PARAMETER(minPos);
127 UNUSED_PARAMETER(minRight);
128 UNUSED_PARAMETER(maxLeft);
129 UNUSED_PARAMETER(stopTime);
130 UNUSED_PARAMETER(bidi);
131 return PersonDist(nullptr, -1);
132 }
133
135 virtual bool usingInternalLanes() = 0;
136
138 virtual bool usingShortcuts() {
139 return false;
140 }
141
143 virtual int getActiveNumber() = 0;
144
145 /* @brief return the arrival direction if the route may be traversed with the given starting direction.
146 * param[out] passedEdges: the number of edges that were successfully traversed
147 * returns UNDEFINED_DIRECTION if the route cannot be traversed
148 */
149 static int canTraverse(int dir, const ConstMSEdgeVector& route, int& passedEdges);
150};
151
152
155public:
157
159 virtual double getEdgePos(SUMOTime now = 0) const = 0;
160
162 virtual int getDirection() const = 0;
163
165 virtual Position getPosition(const MSStageMoving& stage, SUMOTime now) const = 0;
166
168 virtual double getAngle(const MSStageMoving& stage, SUMOTime now) const = 0;
169
171 virtual SUMOTime getWaitingTime() const = 0;
172
174 virtual double getSpeed(const MSStageMoving& stage) const = 0;
175
177 virtual const MSEdge* getNextEdge(const MSStageMoving& stage) const = 0;
178
180 virtual void moveTo(MSPerson* p, MSLane* lane, double lanePos, double lanePosLat, SUMOTime t) {
182 UNUSED_PARAMETER(lane);
183 UNUSED_PARAMETER(lanePos);
184 UNUSED_PARAMETER(lanePosLat);
186 WRITE_WARNING(TL("moveTo is ignored by the current movement model"));
187 }
188
190 virtual void moveToXY(MSPerson* p, Position pos, MSLane* lane, double lanePos,
191 double lanePosLat, double angle, int routeOffset,
192 const ConstMSEdgeVector& edges, SUMOTime t) {
194 UNUSED_PARAMETER(pos);
195 UNUSED_PARAMETER(lane);
196 UNUSED_PARAMETER(lanePos);
197 UNUSED_PARAMETER(lanePosLat);
198 UNUSED_PARAMETER(angle);
199 UNUSED_PARAMETER(routeOffset);
200 UNUSED_PARAMETER(edges);
202 WRITE_WARNING(TL("moveToXY is ignored by the current movement model"));
203 }
204
206 virtual bool isJammed() const {
207 return false;
208 }
209
211 virtual bool isFinished() const {
212 return true;
213 }
214
216 virtual const MSLane* getLane() const {
217 return nullptr;
218 }
219
221 virtual double getPathLength() const {
222 return 0;
223 }
224
227 virtual void saveState(std::ostringstream& out) {
228 UNUSED_PARAMETER(out);
229 }
230
231};
long long int SUMOTime
Definition GUI.h:36
std::vector< const MSEdge * > ConstMSEdgeVector
Definition MSEdge.h:74
std::pair< const MSPerson *, double > PersonDist
Definition MSPModel.h:41
#define WRITE_WARNING(msg)
Definition MsgHandler.h:295
#define TL(string)
Definition MsgHandler.h:315
#define UNUSED_PARAMETER(x)
Definition StdDefs.h:30
A road/street connecting two junctions.
Definition MSEdge.h:77
The base class for an intersection.
Definition MSJunction.h:58
Representation of a lane in the micro simulation.
Definition MSLane.h:84
The simulated network and simulation perfomer.
Definition MSNet.h:89
The pedestrian (and also sometimes container) movement model.
Definition MSPModel.h:51
static const int BACKWARD
Definition MSPModel.h:55
static int canTraverse(int dir, const ConstMSEdgeVector &route, int &passedEdges)
Definition MSPModel.cpp:54
virtual int getActiveNumber()=0
return the number of active objects
virtual void clearState()=0
Resets pedestrians when quick-loading state.
static const int FORWARD
Definition MSPModel.h:54
virtual bool blockedAtDist(const SUMOTrafficObject *ego, const MSLane *lane, double vehSide, double vehWidth, double oncomingGap, std::vector< const MSPerson * > *collectBlockers)
whether a pedestrian is blocking the crossing of lane for the given vehicle bondaries
Definition MSPModel.h:98
virtual PersonDist nextBlocking(const MSLane *lane, double minPos, double minRight, double maxLeft, double stopTime=0, bool bidi=false)
returns the next pedestrian beyond minPos that is laterally between minRight and maxLeft or nullptr
Definition MSPModel.h:124
virtual MSTransportableStateAdapter * add(MSTransportable *transportable, MSStageMoving *stage, SUMOTime now)=0
register the given person as a pedestrian
static const double RANDOM_POS_LAT
magic value to encode randomized lateral offset for persons when starting a walk
Definition MSPModel.h:68
static const double SIDEWALK_OFFSET
the offset for computing person positions when walking on edges without a sidewalk
Definition MSPModel.h:62
virtual MSTransportableStateAdapter * loadState(MSTransportable *transportable, MSStageMoving *stage, std::istringstream &state)
load the state of the given transportable
Definition MSPModel.h:76
virtual bool usingInternalLanes()=0
whether movements on intersections are modelled
virtual void remove(MSTransportableStateAdapter *state)=0
remove the specified person from the pedestrian simulation
virtual ~MSPModel()
Definition MSPModel.h:70
static const int UNDEFINED_DIRECTION
Definition MSPModel.h:56
virtual bool usingShortcuts()
whether travel times and distances can reliably be calculated from the network alone
Definition MSPModel.h:138
virtual bool hasPedestrians(const MSLane *lane)
whether the given lane has pedestrians on it
Definition MSPModel.h:110
static const double UNSPECIFIED_POS_LAT
the default lateral offset for persons when starting a walk
Definition MSPModel.h:65
static const double SAFETY_GAP
Definition MSPModel.h:59
abstract base class for managing callbacks to retrieve various state information from the model
Definition MSPModel.h:154
virtual double getSpeed(const MSStageMoving &stage) const =0
return the current speed of the transportable
virtual void moveToXY(MSPerson *p, Position pos, MSLane *lane, double lanePos, double lanePosLat, double angle, int routeOffset, const ConstMSEdgeVector &edges, SUMOTime t)
try to move transportable to the given position
Definition MSPModel.h:190
virtual Position getPosition(const MSStageMoving &stage, SUMOTime now) const =0
return the network coordinate of the transportable
virtual const MSLane * getLane() const
the current lane of the transportable
Definition MSPModel.h:216
virtual SUMOTime getWaitingTime() const =0
return the time the transportable spent standing
virtual int getDirection() const =0
return the walking direction (FORWARD, BACKWARD, UNDEFINED_DIRECTION)
virtual bool isJammed() const
whether the transportable is jammed
Definition MSPModel.h:206
virtual const MSEdge * getNextEdge(const MSStageMoving &stage) const =0
return the list of internal edges if the transportable is on an intersection
virtual ~MSTransportableStateAdapter()
Definition MSPModel.h:156
virtual void moveTo(MSPerson *p, MSLane *lane, double lanePos, double lanePosLat, SUMOTime t)
try to move transportable to the given position
Definition MSPModel.h:180
virtual bool isFinished() const
whether the transportable has finished walking
Definition MSPModel.h:211
virtual double getAngle(const MSStageMoving &stage, SUMOTime now) const =0
return the direction in which the transportable faces in degrees
virtual double getEdgePos(SUMOTime now=0) const =0
return the offset from the start of the current edge measured in its natural direction
virtual void saveState(std::ostringstream &out)
Saves the current state into the given stream.
Definition MSPModel.h:227
virtual double getPathLength() const
return the total length of the current lane (in particular for on a walkingarea)
Definition MSPModel.h:221
A point in 2D or 3D with translation and scaling methods.
Definition Position.h:37
Representation of a vehicle, person, or container.