Eclipse SUMO - Simulation of Urban MObility
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
MSParkingArea.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2015-2025 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/****************************************************************************/
19// A area where vehicles can park next to the road
20/****************************************************************************/
21#pragma once
22#include <config.h>
23
24#include <vector>
25#include <algorithm>
26#include <map>
27#include <string>
29#include <utils/common/Named.h>
31#include "MSStoppingPlace.h"
32
33
34// ===========================================================================
35// class declarations
36// ===========================================================================
37class MSLane;
38class SUMOVehicle;
39class MSTransportable;
40class MSBaseVehicle;
41class Position;
42class Command;
43
44
45// ===========================================================================
46// class definitions
47// ===========================================================================
61public:
62
77 MSParkingArea(const std::string& id,
78 const std::vector<std::string>& lines,
79 const std::vector<std::string>& badges, MSLane& lane,
80 double begPos, double endPos, int capacity,
81 double width, double length, double angle, const std::string& name,
82 bool onRoad,
83 const std::string& departPos,
84 bool lefthand);
85
87 virtual ~MSParkingArea();
88
90 friend class NLTriggerBuilder;
91
93 int getCapacity() const;
94
96 bool parkOnRoad() const;
97
99 int getLotIndex(const SUMOVehicle* veh) const;
100
107 int getOccupancy() const;
108
111
112 int getOccupancyIncludingReservations(const SUMOVehicle* forVehicle) const;
113
115 int getLastStepOccupancy() const;
116
118 void accept(std::string badge);
119
121 void accept(std::vector<std::string> badges);
122
124 void refuse(std::string badge);
125
127 bool accepts(MSBaseVehicle* veh) const;
128
138 void enter(SUMOVehicle* veh);
139
149 void leaveFrom(SUMOVehicle* what);
150
158 SUMOTime updateOccupancy(SUMOTime currentTime);
159
161 double getLastFreePos(const SUMOVehicle& forVehicle, double brakePos = 0) const;
162
168 double getLastFreePosWithReservation(SUMOTime t, const SUMOVehicle& forVehicle, double brakePos);
169
171 Position getVehiclePosition(const SUMOVehicle& forVehicle) const;
172
174 double getInsertionPosition(const SUMOVehicle& forVehicle) const;
175
177 double getVehicleAngle(const SUMOVehicle& forVehicle) const;
178
180 double getVehicleSlope(const SUMOVehicle& forVehicle) const;
181
187 int getLastFreeLotAngle() const;
188
194 double getLastFreeLotGUIAngle() const;
195
197 int getManoeuverAngle(const SUMOVehicle& forVehicle) const;
198
200 double getGUIAngle(const SUMOVehicle& forVehicle) const;
201
213 virtual void addLotEntry(double x, double y, double z,
214 double width, double length,
215 double angle, double slope);
216
218 double getWidth() const;
219
221 double getLength() const;
222
224 double getAngle() const;
225
227 void notifyEgressBlocked();
228
230 int getNumAlternatives() const;
231
233 void setNumAlternatives(int alternatives);
234
236 std::vector<std::string> getAcceptedBadges() const;
237
239 void setAcceptedBadges(const std::vector<std::string>& badges);
240
241
242protected:
244 void setRoadsideCapacity(int capactity);
245
246protected:
253
255 LotSpaceDefinition(int index, SUMOVehicle* vehicle, double x, double y, double z, double rotation, double slope, double width, double length);
256
258 const int index;
259
262
265
267 const double rotation;
268
270 const double slope;
271
273 const double width;
274
276 const double length;
277
279 double endPos;
280
283
286 };
287
294 void computeLastFreePos();
295
298
301
304
307
309 double myWidth;
310
312 double myLength;
313
315 double myAngle;
316
318 std::vector<LotSpaceDefinition> mySpaceOccupancies;
319
322
324 std::set<std::string> myAcceptedBadges;
325
328
332
336
340
342 std::set<const SUMOVehicle*> myReservedVehicles;
343
346
349
352
356
359
360private:
362 MSParkingArea(const MSParkingArea&) = delete;
363
366};
long long int SUMOTime
Definition GUI.h:36
DepartPosDefinition
Possible ways to choose the departure position.
Base (microsim) event class.
Definition Command.h:50
The base class for microscopic and mesoscopic vehicles.
Representation of a lane in the micro simulation.
Definition MSLane.h:84
A lane area vehicles can halt at.
void notifyEgressBlocked()
update state so that vehicles wishing to enter cooperate with exiting vehicles
int getOccupancyIncludingReservations(const SUMOVehicle *forVehicle) const
double getAngle() const
Returns the lot rectangle angle.
void leaveFrom(SUMOVehicle *what)
Called if a vehicle leaves this stop.
int getNumAlternatives() const
get number alternatives
void refuse(std::string badge)
Remove the access right for the given badge.
int myReservations
number of reservations
int myCapacity
Stop area total capacity.
int getCapacity() const
Returns the area capacity.
void enter(SUMOVehicle *veh)
Called if a vehicle enters this stop.
MSParkingArea(const MSParkingArea &)=delete
Invalidated copy constructor.
int myLastStepOccupancy
Changes to the occupancy in the current time step.
MSParkingArea & operator=(const MSParkingArea &)=delete
Invalidated assignment operator.
bool myOnRoad
Whether vehicles stay on the road.
int myLastFreeLot
Last free lot number (-1 no free lot)
std::vector< std::string > getAcceptedBadges() const
get the accepted badges
SUMOTime myLastReservationTime
void setNumAlternatives(int alternatives)
set number alternatives
PositionVector myShape
The roadside shape of this parkingArea.
double getLength() const
Returns the lot rectangle length.
virtual void addLotEntry(double x, double y, double z, double width, double length, double angle, double slope)
Add a lot entry to parking area.
SUMOTime myReservationTime
track parking reservations from the lane for the current time step
double getWidth() const
Returns the lot rectangle width.
double getVehicleSlope(const SUMOVehicle &forVehicle) const
Returns the slope of parked vehicle.
int myRoadSideCapacity
Stop area capacity configured via roadsideCapacity.
int getLotIndex(const SUMOVehicle *veh) const
compute lot for this vehicle
virtual ~MSParkingArea()
Destructor.
SUMOTime updateOccupancy(SUMOTime currentTime)
Called at the end of the time step.
std::set< const SUMOVehicle * > myReservedVehicles
the set of vehicles that performed a reservation in this step
int getLastFreeLotAngle() const
Return the angle of myLastFreeLot - the next parking lot only expected to be called after we have est...
double myDepartPos
custom departPos
double myAngle
The default angle of each parking space.
bool parkOnRoad() const
whether vehicles park on the road
DepartPosDefinition myDepartPosDefinition
double myReservationMaxLength
reservation max length
int myNumAlternatives
the number of alternative parkingAreas that are assigned to parkingAreaRerouter
double myWidth
The default width of each parking space.
bool accepts(MSBaseVehicle *veh) const
Return the parking accepts the vehicle (due to its given badges)
double myLength
The default length of each parking space.
void computeLastFreePos()
Computes the last free position on this stop.
int getOccupancyIncludingBlocked() const
Returns the area occupancy.
void setAcceptedBadges(const std::vector< std::string > &badges)
set the accepted badges
double getLastFreePosWithReservation(SUMOTime t, const SUMOVehicle &forVehicle, double brakePos)
Returns the last free position on this stop including reservations from the current lane and time ste...
double getLastFreeLotGUIAngle() const
Return the GUI angle of myLastFreeLot - the angle the GUI uses to rotate into the next parking lot as...
int getManoeuverAngle(const SUMOVehicle &forVehicle) const
Return the manoeuver angle of the lot where the vehicle is parked.
int getLastStepOccupancy() const
Returns the area occupancy at the end of the last simulation step.
void accept(std::string badge)
Add a badge to the accepted set.
int getOccupancy() const
Returns the area occupancy.
void setRoadsideCapacity(int capactity)
overwrite the capacity (caution: will delete ANY previous parking space definitions)
double getVehicleAngle(const SUMOVehicle &forVehicle) const
Returns the angle of parked vehicle.
Command * myUpdateEvent
Event for updating the occupancy.
std::vector< LotSpaceDefinition > mySpaceOccupancies
All the spaces in this parking area.
double getInsertionPosition(const SUMOVehicle &forVehicle) const
Returns the insertion position of a parked vehicle.
double myLastReservationMaxLength
Position getVehiclePosition(const SUMOVehicle &forVehicle) const
Returns the position of parked vehicle.
std::set< std::string > myAcceptedBadges
The parking badges to grant access.
double myMaxVehLength
maximum length of all parked vehicles
double getGUIAngle(const SUMOVehicle &forVehicle) const
Return the GUI angle of the lot where the vehicle is parked.
bool myEgressBlocked
whether a vehicle wants to exit but is blocked
A lane area vehicles can halt at.
double getLastFreePos() const
Builds trigger objects for microsim.
A point in 2D or 3D with translation and scaling methods.
Definition Position.h:37
A list of positions.
Representation of a vehicle.
Definition SUMOVehicle.h:62
Representation of a single lot space.
const Position position
The position of the vehicle when parking in this space.
bool sideIsLHS
Whether the lot is on the LHS of the lane relative to the lane direction.
const int index
the running index
double manoeuverAngle
The angle between lane and lot through which a vehicle must manoeuver to enter the lot.
const double rotation
The rotation.
double endPos
The position along the lane that the vehicle needs to reach for entering this lot.
LotSpaceDefinition()
default constructor
const double length
The length.
const SUMOVehicle * vehicle
The last parked vehicle or 0.