MSEdge.h

Go to the documentation of this file.

/****************************************************************************/
// A road/street connecting two junctions
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
// Copyright (C) 2001-2013 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/common/SUMOVehicle.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/common/ValueTimeLine.h>
#include <utils/common/UtilExceptions.h>
#include "MSVehicleType.h"


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


// ===========================================================================
// class definitions
// ===========================================================================
class MSEdge : public Named, public Parameterised {
public:
    enum EdgeBasicFunction {
        EDGEFUNCTION_UNKNOWN = -1,
        EDGEFUNCTION_NORMAL = 0,
        EDGEFUNCTION_CONNECTOR = 1,
        EDGEFUNCTION_INTERNAL = 2,
        EDGEFUNCTION_DISTRICT = 3
    };


    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 = "");


    virtual ~MSEdge();


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


    void closeBuilding();



    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;
    }


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


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




    EdgeBasicFunction getPurpose() const {
        return myFunction;
    }


    int getNumericalID() const {
        return myNumericalID;
    }


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




    void addFollower(MSEdge* edge) {
        mySuccessors.push_back(edge);
    }


    const std::vector<MSEdge*>& getIncomingEdges() const {
        return myPredeccesors;
    }


    unsigned int getNoFollowing() const {
        return (unsigned int) mySuccessors.size();
    }


    const MSEdge* getFollower(unsigned int n) const {
        return mySuccessors[n];
    }




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


    SUMOTime incVaporization(SUMOTime t);


    SUMOTime decVaporization(SUMOTime t);


    SUMOReal getCurrentTravelTime(const SUMOReal minSpeed = 0.00001) const;


    inline SUMOReal getMinimumTravelTime(const SUMOVehicle* const veh) const {
        if (veh != 0) {
            return getLength() / MIN2(veh->getMaxSpeed(), getVehicleMaxSpeed(veh));
        } else {
            return getLength() / getSpeedLimit();
        }
    }



    bool insertVehicle(SUMOVehicle& v, SUMOTime time) const;


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


    MSLane* getDepartLane(const 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(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;
    }

    void rebuildAllowedLanes();


    SUMOReal getDistanceTo(const MSEdge* other) const;


    SUMOReal getLength() const;


    SUMOReal getSpeedLimit() const;


    SUMOReal getVehicleMaxSpeed(const SUMOVehicle* const veh) const;

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

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

    inline bool isRoundabout() const {
        return myAmRoundabout;
    }

    void markAsRoundabout() {
        myAmRoundabout = true;
    }

    bool laneChangeAllowed() const;

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

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

    static MSEdge* dictionary(size_t index);

    static size_t dictSize();

    static size_t numericalDictSize();

    static void clear();

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


public:

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


    static void parseEdgesList(const std::vector<std::string>& desc, std::vector<const MSEdge*>& 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();
        }

    };


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


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

protected:
    int myNumericalID;

    std::vector<MSLane*>* myLanes;

    MSLaneChanger* myLaneChanger;

    const EdgeBasicFunction myFunction;

    int myVaporizationRequests;

    mutable SUMOTime myLastFailedInsertionTime;

    std::vector<MSEdge*> mySuccessors;

    std::vector<MSEdge*> myPredeccesors;

    mutable std::set<MSPerson*> myPersons;


    AllowedLanesCont myAllowed;

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

    SVCPermissions myMinimumPermissions;
    SVCPermissions myCombinedPermissions;

    std::string myStreetName;

    bool myAmRoundabout;


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

    static DictType myDict;

    static std::vector<MSEdge*> myEdges;



private:
    MSEdge(const MSEdge&);

    MSEdge& operator=(const MSEdge&);

};


#endif

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