MSParkingArea.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2015-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A area where vehicles can park next to the road
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <algorithm>
#include <map>
#include <string>
#include <utils/geom/PositionVector.h>
#include <utils/common/Named.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include "MSStoppingPlace.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
class SUMOVehicle;
class MSTransportable;
class MSBaseVehicle;
class Position;
class Command;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSParkingArea : public MSStoppingPlace {
public:
 
    struct LotSpaceDefinition {
        LotSpaceDefinition();
 
        LotSpaceDefinition(int index, SUMOVehicle* vehicle, double x, double y, double z, double rotation, double slope, double width, double length);
 
        const int index;
 
        const SUMOVehicle* vehicle;
 
        const Position position;
 
        const double rotation;
 
        const double slope;
 
        const double width;
 
        const double length;
 
        double endPos;
 
        double manoeuverAngle;
 
        bool sideIsLHS;
    };
 
    MSParkingArea(const std::string& id,
                  const std::vector<std::string>& lines,
                  const std::vector<std::string>& badges, MSLane& lane,
                  double begPos, double endPos, int capacity,
                  double width, double length, double angle, const std::string& name,
                  bool onRoad,
                  const std::string& departPos,
                  bool lefthand, bool reservable);
 
    virtual ~MSParkingArea();
 
    friend class NLTriggerBuilder;
 
    int getCapacity() const;
 
    bool parkOnRoad() const;
 
    bool mustAdvance(SUMOVehicleClass svc) const;
 
    inline bool isReservable() const {
        return myReservable;
    }
 
    int getLotIndex(const SUMOVehicle* veh) const;
 
    int getOccupancy() const;
 
    int getOccupancyIncludingBlocked() const;
 
    int getOccupancyIncludingReservations(const SUMOVehicle* forVehicle) const;
 
    int getOccupancyIncludingRemoteReservations(const SUMOVehicle* forVehicle) const;
 
    int getLastStepOccupancy() const;
 
    int getLastStepOccupancyIncludingRemoteReservations(const SUMOVehicle* forVehicle) const;
 
    void accept(std::string badge);
 
    void accept(std::vector<std::string> badges);
 
    void refuse(std::string badge);
 
    bool accepts(SUMOVehicle* veh) const;
 
    void enter(SUMOVehicle* veh, const bool parking);
 
    void leaveFrom(SUMOVehicle* what);
 
    void addSpaceReservation(const SUMOVehicle* veh);
    void removeSpaceReservation(const SUMOVehicle* veh);
 
    const std::set<const SUMOVehicle*>& getRemoteReservedVehicles() const {
        return myRemoteReservedVehicles;
    }
 
    SUMOTime updateOccupancy(SUMOTime currentTime);
 
    double getLastFreePos(const SUMOVehicle& forVehicle, double brakePos = 0) const;
 
    double getLastFreePosWithReservation(SUMOTime t, const SUMOVehicle& forVehicle, double brakePos);
 
    Position getVehiclePosition(const SUMOVehicle& forVehicle) const;
 
    double getInsertionPosition(const SUMOVehicle& forVehicle) const;
 
    double getVehicleAngle(const SUMOVehicle& forVehicle) const;
 
    double getVehicleSlope(const SUMOVehicle& forVehicle) const;
 
    int getLastFreeLotAngle() const;
 
    double getLastFreeLotGUIAngle() const;
 
    int getManoeuverAngle(const SUMOVehicle& forVehicle) const;
 
    double getGUIAngle(const SUMOVehicle& forVehicle) const;
 
    virtual void addLotEntry(double x, double y, double z,
                             double width, double length,
                             double angle, double slope);
 
    double getWidth() const;
 
    double getLength() const;
 
    double getAngle() const;
 
    void notifyEgressBlocked();
 
    int getNumAlternatives() const;
 
    void setNumAlternatives(int alternatives);
 
    std::vector<std::string> getAcceptedBadges() const;
 
    void setAcceptedBadges(const std::vector<std::string>& badges);
 
    const std::vector<LotSpaceDefinition>& getSpaceOccupancies() const;
 
    const PositionVector& getShape() const;
 
 
protected:
    void setRoadsideCapacity(int capactity);
 
    bool cannotChange(SUMOVehicleClass svc) const; 
 
protected:
 
 
    void computeLastFreePos();
 
    int myLastFreeLot;
 
    int myRoadSideCapacity;
 
    int myCapacity;
 
    bool myOnRoad;
 
    bool myReservable;
 
    double myWidth;
 
    double myLength;
 
    double myAngle;
 
    std::vector<LotSpaceDefinition> mySpaceOccupancies;
 
    PositionVector myShape;
 
    std::set<std::string> myAcceptedBadges;
 
    bool myEgressBlocked;
 
    SUMOTime myReservationTime;
    SUMOTime myLastReservationTime;
 
    int myReservations;
    int myLastReservations;
 
    double myReservationMaxLength;
    double myLastReservationMaxLength;
 
    std::set<const SUMOVehicle*> myReservedVehicles;
    std::set<const SUMOVehicle*> myRemoteReservedVehicles;
    std::set<const SUMOVehicle*> myLastRemoteReservedVehicles;
 
    double myMaxVehLength;
 
    int myNumAlternatives;
 
    int myLastStepOccupancy;
 
    double myDepartPos;
    DepartPosDefinition myDepartPosDefinition;
 
    Command* myUpdateEvent;
 
private:
    MSParkingArea(const MSParkingArea&) = delete;
 
    MSParkingArea& operator=(const MSParkingArea&) = delete;
};