MSEdge.h

Go to the documentation of this file.

/****************************************************************************/
// A road/street connecting two junctions
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSEdge_h
#define MSEdge_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <vector>
#include <map>
#include <string>
#include <iostream>
#include <utils/common/Named.h>
#include <utils/common/Parameterised.h>
#include <utils/common/SUMOTime.h>
#include <utils/vehicle/SUMOVehicle.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/common/ValueTimeLine.h>
#include <utils/common/UtilExceptions.h>
#include "MSNet.h"
#include "MSVehicleType.h"


// ===========================================================================
// class declarations
// ===========================================================================
class MSLaneChanger;
class OutputDevice;
class SUMOVehicle;
class SUMOVehicleParameter;
class MSVehicle;
class MSLane;
class MSPerson;
class MSJunction;
class MSEdge;
class MSContainer;

// ===========================================================================
// class definitions
// ===========================================================================
typedef std::vector<MSEdge*> MSEdgeVector;
typedef std::vector<const MSEdge*> ConstMSEdgeVector;

class MSEdge : public Named, public Parameterised {
public:
    enum EdgeBasicFunction {
        EDGEFUNCTION_UNKNOWN = -1,
        EDGEFUNCTION_NORMAL = 0,
        EDGEFUNCTION_CONNECTOR = 1,
        EDGEFUNCTION_INTERNAL = 2,
        EDGEFUNCTION_DISTRICT = 3,
        EDGEFUNCTION_CROSSING = 4,
        EDGEFUNCTION_WALKINGAREA = 5
    };


    typedef std::map< const MSEdge*, std::vector<MSLane*>* > AllowedLanesCont;

    typedef std::map< SUMOVehicleClass, AllowedLanesCont > ClassedAllowedLanesCont;


public:
    MSEdge(const std::string& id, int numericalID, const EdgeBasicFunction function,
           const std::string& streetName, const std::string& edgeType, int priority);


    virtual ~MSEdge();


    void initialize(const std::vector<MSLane*>* lanes);


    void recalcCache();


    void closeBuilding();

    void buildLaneChanger();

    /* @brief returns whether initizliaing a lane change is permitted on this edge
     * @note Has to be called after all sucessors and predecessors have been set (after closeBuilding())
     */
    bool allowsLaneChanging();


    MSLane* leftLane(const MSLane* const lane) const;


    MSLane* rightLane(const MSLane* const lane) const;


    MSLane* parallelLane(const MSLane* const lane, int offset) const;


    const std::vector<MSLane*>& getLanes() const {
        return *myLanes;
    }

    inline const std::set<MSTransportable*>& getPersons() const {
        return myPersons;
    }

    std::vector<MSTransportable*> getSortedPersons(SUMOTime timestep) const;


    std::vector<MSTransportable*> getSortedContainers(SUMOTime timestep) const;

    const std::vector<MSLane*>* allowedLanes(const MSEdge& destination,
            SUMOVehicleClass vclass = SVC_IGNORING) const;


    const std::vector<MSLane*>* allowedLanes(SUMOVehicleClass vclass = SVC_IGNORING) const;




    EdgeBasicFunction getPurpose() const {
        return myFunction;
    }

    inline bool isInternal() const {
        return myFunction == EDGEFUNCTION_INTERNAL;
    }

    inline bool isCrossing() const {
        return myFunction == EDGEFUNCTION_CROSSING;
    }

    inline bool isWalkingArea() const {
        return myFunction == EDGEFUNCTION_WALKINGAREA;
    }

    inline bool isTaz() const {
        return myFunction == EDGEFUNCTION_DISTRICT;
    }

    inline int getNumericalID() const {
        return myNumericalID;
    }


    const std::string& getStreetName() const {
        return myStreetName;
    }

    const std::string& getEdgeType() const {
        return myEdgeType;
    }

    int getPriority() const {
        return myPriority;
    }

    void setCrossingEdges(const std::vector<std::string>& crossingEdges)        {
        myCrossingEdges.clear();
        myCrossingEdges.insert(myCrossingEdges.begin(), crossingEdges.begin(), crossingEdges.end());
    }

    const std::vector<std::string>& getCrossingEdges() const {
        return myCrossingEdges;
    }



    void addSuccessor(MSEdge* edge) {
        mySuccessors.push_back(edge);
        edge->myPredecessors.push_back(this);
    }


    int getNumSuccessors() const {
        return (int) mySuccessors.size();
    }


    const MSEdgeVector& getSuccessors() const {
        return mySuccessors;
    }


    const MSEdgeVector& getSuccessors(SUMOVehicleClass vClass) const;


    int getNumPredecessors() const {
        return (int) myPredecessors.size();
    }


    const MSEdgeVector& getPredecessors() const {
        return myPredecessors;
    }


    const MSJunction* getFromJunction() const {
        return myFromJunction;
    }

    const MSJunction* getToJunction() const {
        return myToJunction;
    }


    void setJunctions(MSJunction* from, MSJunction* to) {
        myFromJunction = from;
        myToJunction = to;
    }




    bool isVaporizing() const {
        return myVaporizationRequests > 0;
    }


    SUMOTime incVaporization(SUMOTime t);


    SUMOTime decVaporization(SUMOTime t);


    SUMOReal getCurrentTravelTime(const SUMOReal minSpeed = NUMERICAL_EPS) const;


    inline SUMOReal getMinimumTravelTime(const SUMOVehicle* const veh) const {
        if (myFunction == EDGEFUNCTION_DISTRICT) {
            return 0;
        } else if (veh != 0) {
            return getLength() / getVehicleMaxSpeed(veh);
        } else {
            return getLength() / getSpeedLimit();
        }
    }


    static inline SUMOReal getTravelTimeStatic(const MSEdge* const edge, const SUMOVehicle* const veh, SUMOReal time) {
        return MSNet::getInstance()->getTravelTime(edge, veh, time);
    }

    SUMOReal getRoutingSpeed() const;



    bool insertVehicle(SUMOVehicle& v, SUMOTime time, const bool checkOnly = false, const bool forceCheck = false) const;


    MSLane* getFreeLane(const std::vector<MSLane*>* allowed, const SUMOVehicleClass vclass) const;


    MSLane* getDepartLane(MSVehicle& veh) const;


    inline SUMOTime getLastFailedInsertionTime() const {
        return myLastFailedInsertionTime;
    }


    inline void setLastFailedInsertionTime(SUMOTime time) const {
        myLastFailedInsertionTime = time;
    }


    virtual void changeLanes(SUMOTime t);


#ifdef HAVE_INTERNAL_LANES
    const MSEdge* getInternalFollowingEdge(const MSEdge* followerAfterInternal) const;
#endif

    inline bool prohibits(const SUMOVehicle* const vehicle) const {
        if (vehicle == 0) {
            return false;
        }
        const SUMOVehicleClass svc = vehicle->getVehicleType().getVehicleClass();
        return (myCombinedPermissions & svc) != svc;
    }

    inline SVCPermissions getPermissions() const {
        return myCombinedPermissions;
    }

    SUMOReal getWidth() const {
        return myWidth;
    }

    const std::vector<SUMOReal> getSubLaneSides() const {
        return mySublaneSides;
    }

    void rebuildAllowedLanes();


    SUMOReal getDistanceTo(const MSEdge* other) const;


    inline SUMOReal getLength() const {
        return myLength;
    }


    SUMOReal getSpeedLimit() const;

    void setMaxSpeed(SUMOReal val) const;

    SUMOReal getVehicleMaxSpeed(const SUMOVehicle* const veh) const;

    virtual void addPerson(MSTransportable* p) const {
        myPersons.insert(p);
    }

    virtual void removePerson(MSTransportable* p) const {
        std::set<MSTransportable*>::iterator i = myPersons.find(p);
        if (i != myPersons.end()) {
            myPersons.erase(i);
        }
    }

    virtual void addContainer(MSTransportable* container) const {
        myContainers.insert(container);
    }

    virtual void removeContainer(MSTransportable* container) const {
        std::set<MSTransportable*>::iterator i = myContainers.find(container);
        if (i != myContainers.end()) {
            myContainers.erase(i);
        }
    }

    inline bool isRoundabout() const {
        return myAmRoundabout;
    }

    void markAsRoundabout() {
        myAmRoundabout = true;
    }

    void markDelayed() const {
        myAmDelayed = true;
    }

    bool hasLaneChanger() const {
        return myLaneChanger != 0;
    }

    bool canChangeToOpposite();

    SUMOReal getMeanSpeed() const;

    bool hasMinorLink() const;

    virtual void lock() const {}

    virtual void unlock() const {};

    static bool dictionary(const std::string& id, MSEdge* edge);

    static MSEdge* dictionary(const std::string& id);

    static int dictSize();

    static const MSEdgeVector& getAllEdges();

    static void clear();

    static void insertIDs(std::vector<std::string>& into);


public:

    static void parseEdgesList(const std::string& desc, ConstMSEdgeVector& into,
                               const std::string& rid);


    static void parseEdgesList(const std::vector<std::string>& desc, ConstMSEdgeVector& into,
                               const std::string& rid);


protected:
    class by_id_sorter {
    public:
        explicit by_id_sorter() { }

        int operator()(const MSEdge* const e1, const MSEdge* const e2) const {
            return e1->getID() < e2->getID();
        }

    };

    class transportable_by_position_sorter {
    public:
        explicit transportable_by_position_sorter(SUMOTime timestep): myTime(timestep) { }

        int operator()(const MSTransportable* const c1, const MSTransportable* const c2) const;
    private:
        SUMOTime myTime;
    };


    const std::vector<MSLane*>* allowedLanes(const MSEdge* destination,
            SUMOVehicleClass vclass = SVC_IGNORING) const;


    const std::vector<MSLane*>* getAllowedLanesWithDefault(const AllowedLanesCont& c, const MSEdge* dest) const;


protected:
    const int myNumericalID;

    const std::vector<MSLane*>* myLanes;

    MSLaneChanger* myLaneChanger;

    const EdgeBasicFunction myFunction;

    int myVaporizationRequests;

    mutable SUMOTime myLastFailedInsertionTime;

    mutable std::set<int> myFailedInsertionMemory;

    std::vector<std::string> myCrossingEdges;

    MSEdgeVector mySuccessors;

    MSEdgeVector myPredecessors;

    MSJunction* myFromJunction;
    MSJunction* myToJunction;

    mutable std::set<MSTransportable*> myPersons;

    mutable std::set<MSTransportable*> myContainers;


    AllowedLanesCont myAllowed;

    // @note: this map is filled on demand
    mutable ClassedAllowedLanesCont myClassedAllowed;

    SVCPermissions myMinimumPermissions;
    SVCPermissions myCombinedPermissions;

    std::string myStreetName;

    std::string myEdgeType;

    const int myPriority;

    SUMOReal myWidth;

    SUMOReal myLength;

    SUMOReal myEmptyTraveltime;

    mutable bool myAmDelayed;

    bool myAmRoundabout;

    std::vector<SUMOReal> mySublaneSides;


    typedef std::map< std::string, MSEdge* > DictType;

    static DictType myDict;

    static MSEdgeVector myEdges;


    mutable std::map<SUMOVehicleClass, MSEdgeVector> myClassesSuccessorMap;

private:
    MSEdge(const MSEdge&);

    MSEdge& operator=(const MSEdge&);

};


#endif

/****************************************************************************/