MSStoppingPlace.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2005-2025 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 lane area vehicles can halt at
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <algorithm>
#include <map>
#include <string>
#include <utils/common/Named.h>
#include <utils/common/Parameterised.h>
#include <utils/common/RGBColor.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
class MSEdge;
class SUMOVehicle;
class MSTransportable;
class Position;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSStoppingPlace : public Named, public Parameterised {
public:
    enum class AccessExit {
        PLATFORM,
        DOORS,
        CARRIAGE
    };
 
    struct Access {
        MSLane* const lane;
        const double startPos;
        const double endPos;
        const double length;
        const AccessExit exit;
    };
 
    MSStoppingPlace(const std::string& id,
                    SumoXMLTag element,
                    const std::vector<std::string>& lines, MSLane& lane,
                    double begPos, double endPos,
                    const std::string name = "",
                    int capacity = 0,
                    double parkingLength = 0,
                    const RGBColor& color = RGBColor::INVISIBLE,
                    double angle = 90);
 
 
 
    virtual ~MSStoppingPlace();
 
 
    const MSLane& getLane() const;
 
 
    double getBeginLanePosition() const;
 
 
    double getEndLanePosition() const;
 
    double getAngle() const {
        return myAngle;
    }
 
    Position getCenterPos() const;
 
    virtual void enter(SUMOVehicle* veh, const bool parking);
 
 
    virtual void leaveFrom(SUMOVehicle* what);
 
 
    virtual double getLastFreePos(const SUMOVehicle& forVehicle, double brakePos = 0) const;
 
    virtual bool accepts(SUMOVehicle* /*veh*/) const {
        return true;
    }
 
    bool fits(double pos, const SUMOVehicle& veh) const;
 
    Position getWaitPosition(MSTransportable* person) const;
 
    double getWaitingPositionOnLane(MSTransportable* t) const;
 
 
    double getStoppingPosition(const SUMOVehicle* veh) const;
 
    int getTransportableNumber() const {
        return (int)myWaitingTransportables.size();
    }
 
    std::vector<const MSTransportable*> getTransportables() const;
 
    int getStoppedVehicleNumber() const {
        return (int)myEndPositions.size();
    }
 
    double getLastFreePos() const {
        return myLastFreePos;
    }
 
    bool hasSpaceForTransportable() const;
 
    bool addTransportable(const MSTransportable* p);
 
    void removeTransportable(const MSTransportable* p);
 
    virtual bool addAccess(MSLane* const lane, const double startPos, const double endPos, double length, const MSStoppingPlace::AccessExit exit);
 
    const std::vector<Access>& getAllAccessPos() const {
        return myAccessPos;
    }
 
    double getAccessPos(const MSEdge* edge, SumoRNG* rng = nullptr) const;
 
    const Access* getAccess(const MSEdge* edge) const;
 
    const std::string& getMyName() const;
 
    SumoXMLTag getElement() const {
        return myElement;
    }
 
    const RGBColor& getColor() const;
 
    static int getDefaultTransportablesAbreast(double length, SumoXMLTag element);
 
    std::vector<const SUMOVehicle*> getStoppedVehicles() const;
 
    inline int getNumWaitingPersons() const {
        return (int)myWaitingTransportables.size();
    }
 
    inline int getWaitingCapacity() const {
        return myTransportableCapacity;
    }
 
    inline double getParkingLength() const {
        return (myEndPos - myBegPos) / myParkingFactor;
    }
 
    void getWaitingPersonIDs(std::vector<std::string>& into) const;
 
    bool checkPersonCapacity() const {
        return myElement == SUMO_TAG_BUS_STOP || myElement == SUMO_TAG_TRAIN_STOP;;
    }
 
    virtual void finishedLoading();
 
    void clearState();
 
protected:
    void computeLastFreePos();
 
    int getTransportablesAbreast() const;
 
    static double getDefaultTransportableWidth(SumoXMLTag element);
 
protected:
    const SumoXMLTag myElement;
 
    std::vector<std::string> myLines;
 
    std::map<const SUMOVehicle*, std::pair<double, double>, ComparatorNumericalIdLess> myEndPositions;
 
    const MSLane& myLane;
 
    const double myBegPos;
 
    const double myEndPos;
 
    double myLastFreePos;
    const SUMOVehicle* myLastParking;
 
    const std::string myName;
 
    const int myTransportableCapacity;
 
    const double myParkingFactor;
 
    const RGBColor myColor;
 
    double myAngle;
 
    double myTransportableDepth;
    double myTransportableWidth;
 
    std::map<const MSTransportable*, int> myWaitingTransportables;
    std::set<int> myWaitingSpots;
 
    std::vector<Access> myAccessPos;
 
private:
    MSStoppingPlace(const MSStoppingPlace&);
 
    MSStoppingPlace& operator=(const MSStoppingPlace&);
 
 
};