MSEdge.h

Go to the documentation of this file.

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


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


// ===========================================================================
// class definitions
// ===========================================================================
class MSEdge {
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, unsigned int numericalID, const std::string& streetName = "") ;


    virtual ~MSEdge() ;


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


    void closeBuilding();



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


    MSLane* rightLane(const MSLane* const lane) 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 ;




    const std::string& getID() const {
        return myID;
    }


    EdgeBasicFunction getPurpose() const {
        return myFunction;
    }


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




    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

    bool prohibits(const SUMOVehicle* const vehicle) const ;

    void rebuildAllowedLanes() ;



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

protected:
    std::string myID;

    unsigned int myNumericalID;

    std::vector<MSLane*>* myLanes;

    MSLaneChanger* myLaneChanger;

    EdgeBasicFunction myFunction;

    int myVaporizationRequests;

    mutable SUMOTime myLastFailedInsertionTime;

    std::vector<MSEdge*> mySuccessors;

    std::vector<MSEdge*> myPredeccesors;




    AllowedLanesCont myAllowed;

    ClassedAllowedLanesCont myClassedAllowed;

    bool myHaveClassConstraints;

    std::string myStreetName;




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

    static DictType myDict;

    static std::vector<MSEdge*> myEdges;



private:
    MSEdge(const MSEdge&);

    MSEdge& operator=(const MSEdge&);

};


#endif

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