MSLane.h

Go to the documentation of this file.

/****************************************************************************/
// Representation of a lane in the micro simulation
/****************************************************************************/
// 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 MSLane_h
#define MSLane_h


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

#include "MSEdge.h"
#include "MSLinkCont.h"
#include "MSVehicle.h"
#include <bitset>
#include <deque>
#include <vector>
#include <utility>
#include <map>
#include <string>
#include <iostream>
#include "MSNet.h"
#include <utils/geom/PositionVector.h>
#include <utils/geom/Line.h>
#include <utils/geom/GeomHelper.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/common/Named.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSLaneChanger;
class MSLink;
class MSMoveReminder;
class GUILaneWrapper;
class MSVehicleTransfer;
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class MSLane : public Named {
public:
    friend class MSLaneChanger;

    friend class GUILaneWrapper;

    friend class MSXMLRawOut;

    struct VehPosition : public std::binary_function < const MSVehicle*,
            SUMOReal, bool > {
        bool operator()(const MSVehicle* cmp, SUMOReal pos) const {
            return cmp->getPositionOnLane() >= pos;
        }
    };

public:
    MSLane(const std::string& id, SUMOReal maxSpeed, SUMOReal length, MSEdge* const edge,
           unsigned int numericalID, const PositionVector& shape, SUMOReal width,
           const SUMOVehicleClasses& allowed,
           const SUMOVehicleClasses& disallowed) ;


    virtual ~MSLane() ;




    void initialize(MSLinkCont* succs);

    void addLink(MSLink* link);




    virtual void addMoveReminder(MSMoveReminder* rem) ;


    inline const std::vector< MSMoveReminder* > &getMoveReminders() const {
        return myMoveReminders;
    }




    bool insertVehicle(MSVehicle& v) ;


    virtual bool isInsertionSuccess(MSVehicle* vehicle, SUMOReal speed, SUMOReal pos,
                                    bool recheckNextLanes,
                                    MSMoveReminder::Notification notification = MSMoveReminder::NOTIFICATION_DEPARTED) ;

    bool pWagGenericInsertion(MSVehicle& veh, SUMOReal speed, SUMOReal maxPos, SUMOReal minPos) ;
    bool pWagSimpleInsertion(MSVehicle& veh, SUMOReal speed, SUMOReal maxPos, SUMOReal minPos) ;
    bool maxSpeedGapInsertion(MSVehicle& veh, SUMOReal mspeed) ;

    bool freeInsertion(MSVehicle& veh, SUMOReal speed,
                       MSMoveReminder::Notification notification = MSMoveReminder::NOTIFICATION_DEPARTED) ;


    void forceVehicleInsertion(MSVehicle* veh, SUMOReal pos) ;




    SUMOReal setPartialOccupation(MSVehicle* v, SUMOReal leftVehicleLength) ;


    void resetPartialOccupation(MSVehicle* v) ;


    MSVehicle* getPartialOccupator() const {
        return myInlappingVehicle;
    }


    SUMOReal getPartialOccupatorEnd() const {
        return myInlappingVehicleEnd;
    }


    std::pair<MSVehicle*, SUMOReal> getLastVehicleInformation() const ;




    unsigned int getVehicleNumber() const {
        return (unsigned int) myVehicles.size();
    }


    virtual const std::deque< MSVehicle* > &getVehiclesSecure() const {
        return myVehicles;
    }


    virtual void releaseVehicles() const { }





    size_t getNumericalID() const {
        return myNumericalID;
    }


    const PositionVector& getShape() const {
        return myShape;
    }


    SUMOReal getMaxSpeed() const {
        return myMaxSpeed;
    }


    SUMOReal getLength() const {
        return myLength;
    }


    const SUMOVehicleClasses& getAllowedClasses() const {
        return myAllowedClasses;
    }


    const SUMOVehicleClasses& getNotAllowedClasses() const {
        return myNotAllowedClasses;
    }


    SUMOReal getWidth() const {
        return myWidth;
    }




    virtual bool moveCritical(SUMOTime t);

    virtual bool setCritical(SUMOTime t, std::vector<MSLane*> &into);

    virtual bool integrateNewVehicle(SUMOTime t);



    virtual void detectCollisions(SUMOTime timestep);


    virtual bool appropriate(const MSVehicle* veh);


    const MSLinkCont& getLinkCont() const;


    bool empty() const {
        assert(myVehBuffer.size() == 0);
        return myVehicles.empty();
    }

    void setMaxSpeed(SUMOReal val) {
        myMaxSpeed = val;
    }

    void setLength(SUMOReal val) {
        myLength = val;
    }


    MSEdge& getEdge() const {
        return *myEdge;
    }

    static bool dictionary(std::string id, MSLane* lane);

    static MSLane* dictionary(std::string id);

    static void clear();

    static size_t dictSize() {
        return myDict.size();
    }

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

    typedef std::deque< MSVehicle* > VehCont;

    virtual MSLinkCont::const_iterator succLinkSec(const SUMOVehicle& veh,
            unsigned int nRouteSuccs,
            const MSLane& succLinkSource,
            const std::vector<MSLane*> &conts) const;


    bool isLinkEnd(MSLinkCont::const_iterator& i) const;

    bool isLinkEnd(MSLinkCont::iterator& i);

    virtual MSVehicle* getLastVehicle() const;
    virtual const MSVehicle* getFirstVehicle() const;




    // valid for gui-version only
    virtual GUILaneWrapper* buildLaneWrapper(unsigned int index);

    virtual MSVehicle* removeVehicle(MSVehicle* remVehicle);

    PositionVector myShape;



    void leftByLaneChange(MSVehicle* v);
    void enteredByLaneChange(MSVehicle* v);


    MSLane* getLeftLane() const;
    MSLane* getRightLane() const;

    void setAllowedClasses(const SUMOVehicleClasses& classes) {
        myAllowedClasses = classes;
    }


    void setNotAllowedClasses(const SUMOVehicleClasses& classes) {
        myNotAllowedClasses = classes;
    }


    bool allowsVehicleClass(SUMOVehicleClass vclass) const;

    void addIncomingLane(MSLane* lane, MSLink* viaLink);


    struct IncomingLaneInfo {
        MSLane* lane;
        SUMOReal length;
        MSLink* viaLink;
    };

    const std::vector<IncomingLaneInfo> &getIncomingLanes() const {
        return myIncomingLanes;
    }


    void addApproachingLane(MSLane* lane);
    bool isApproachedFrom(MSEdge* const edge);
    bool isApproachedFrom(MSEdge* const edge, MSLane* const lane);



    std::pair<MSVehicle* const, SUMOReal> getFollowerOnConsecutive(SUMOReal dist, SUMOReal seen,
            SUMOReal leaderSpeed, SUMOReal backOffset, SUMOReal predMaxDecel) const;


    std::pair<MSVehicle* const, SUMOReal> getLeaderOnConsecutive(SUMOReal dist, SUMOReal seen,
            SUMOReal speed, const MSVehicle& veh, const std::vector<MSLane*> &bestLaneConts) const ;


    MSLane* getLogicalPredecessorLane() const ;




    SUMOReal getMeanSpeed() const ;


    SUMOReal getOccupancy() const ;


    SUMOReal getVehLenSum() const ;


    SUMOReal getHBEFA_CO2Emissions() const ;


    SUMOReal getHBEFA_COEmissions() const ;


    SUMOReal getHBEFA_PMxEmissions() const ;


    SUMOReal getHBEFA_NOxEmissions() const ;


    SUMOReal getHBEFA_HCEmissions() const ;


    SUMOReal getHBEFA_FuelConsumption() const ;


    SUMOReal getHarmonoise_NoiseEmissions() const ;


protected:
    virtual void swapAfterLaneChange(SUMOTime t);

    virtual void incorporateVehicle(MSVehicle* veh, SUMOReal pos, SUMOReal speed,
                                    const MSLane::VehCont::iterator& at,
                                    MSMoveReminder::Notification notification = MSMoveReminder::NOTIFICATION_DEPARTED) ;


protected:
    size_t myNumericalID;

    VehCont myVehicles;

    SUMOReal myLength;

    SUMOReal myWidth;

    MSEdge* myEdge;

    SUMOReal myMaxSpeed;

    VehCont myTmpVehicles;


    SUMOReal myBackDistance;

    std::vector<MSVehicle*> myVehBuffer;

    SUMOVehicleClasses myAllowedClasses;

    SUMOVehicleClasses myNotAllowedClasses;

    std::vector<IncomingLaneInfo> myIncomingLanes;
    mutable MSLane* myLogicalPredecessorLane;


    SUMOReal myVehicleLengthSum;

    SUMOReal myInlappingVehicleEnd;

    MSVehicle* myInlappingVehicle;


    SUMOReal myLeftVehLength;

    MSLinkCont myLinks;

    std::map<MSEdge*, std::vector<MSLane*> > myApproachingLanes;



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

    static DictType myDict;

private:
    std::vector< MSMoveReminder* > myMoveReminders;


    class vehicle_position_sorter {
    public:
        explicit vehicle_position_sorter() { }


        int operator()(MSVehicle* v1, MSVehicle* v2) const {
            return v1->getPositionOnLane() > v2->getPositionOnLane();
        }

    };

    class by_connections_to_sorter {
    public:
        explicit by_connections_to_sorter(const MSEdge* const e)
            : myEdge(e), myLaneDir(e->getLanes()[0]->getShape().getBegLine().atan2PositiveAngle()) { }

        int operator()(const MSEdge* const e1, const MSEdge* const e2) const {
            const std::vector<MSLane*>* ae1 = e1->allowedLanes(*myEdge);
            const std::vector<MSLane*>* ae2 = e2->allowedLanes(*myEdge);
            SUMOReal s1 = 0;
            if (ae1 != 0 && ae1->size() != 0) {
                s1 = (SUMOReal) ae1->size() + GeomHelper::getMinAngleDiff((*ae1)[0]->getShape().getBegLine().atan2PositiveAngle(), myLaneDir) / PI / 2.;
            }
            SUMOReal s2 = 0;
            if (ae2 != 0 && ae2->size() != 0) {
                s2 = (SUMOReal) ae2->size() + GeomHelper::getMinAngleDiff((*ae2)[0]->getShape().getBegLine().atan2PositiveAngle(), myLaneDir) / PI / 2.;
            }
            return s1 < s2;
        }

    private:
        by_connections_to_sorter& operator=(const by_connections_to_sorter&); // just to avoid a compiler warning
    private:
        const MSEdge* const myEdge;
        SUMOReal myLaneDir;
    };

    class edge_finder {
    public:
        edge_finder(MSEdge* e) : myEdge(e) {}
        bool operator()(const IncomingLaneInfo& ili) const {
            return &(ili.lane->getEdge()) == myEdge;
        }
    private:
        edge_finder& operator=(const edge_finder&); // just to avoid a compiler warning
    private:
        const MSEdge* const myEdge;
    };

private:
    MSLane(const MSLane&);

    MSLane& operator=(const MSLane&);


};


#endif

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