MSLaneChanger.h

Go to the documentation of this file.

/****************************************************************************/
// Performs lane changing of vehicles
/****************************************************************************/
// 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 MSLaneChanger_h
#define MSLaneChanger_h


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

#include "MSLane.h"
#include "MSEdge.h"
#include "MSVehicle.h"
#include <vector>
#include <utils/iodevices/OutputDevice.h>


// ===========================================================================
// class declarations
// ===========================================================================


// ===========================================================================
// class definitions
// ===========================================================================
class MSLaneChanger {
public:
    MSLaneChanger(std::vector<MSLane*>* lanes, bool allowSwap);

    ~MSLaneChanger();

    void laneChange(SUMOTime t);

public:
    struct ChangeElem {
        MSVehicle*                follow;
        MSVehicle*                lead;
        MSLane*                   lane;
        MSLane::VehCont::reverse_iterator veh;
        MSVehicle*                hoppedVeh;
        MSVehicle*                lastBlocked;
        MSVehicle*                firstBlocked;

        SUMOReal dens;

    };

public:
    typedef std::vector< ChangeElem > Changer;

    typedef Changer::iterator ChangerIt;

    typedef Changer::const_iterator ConstChangerIt;

protected:
    void initChanger();

    bool vehInChanger() const {
        // If there is at least one valid vehicle under the veh's in myChanger
        // return true.
        for (ConstChangerIt ce = myChanger.begin(); ce != myChanger.end(); ++ce) {
            if (veh(ce) != 0) {
                return true;
            }
        }
        return false;
    }

    MSVehicle* veh(ConstChangerIt ce) const {
        // If ce has a valid vehicle, return it. Otherwise return 0.
        if (ce->veh != ce->lane->myVehicles.rend()) {
            return *(ce->veh);
        }
        return 0;
    }


    bool change();

    void registerUnchanged(MSVehicle* vehicle);

    void updateChanger(bool vehHasChanged);

    void updateLanes(SUMOTime t);

    ChangerIt findCandidate();

    /* @brief check whether lane changing in the given direction is desirable
     * and possible */
    int checkChange(
        int laneOffset,
        const std::pair<MSVehicle* const, SUMOReal>& leader,
        const std::vector<MSVehicle::LaneQ>& preb) const;

    void startChange(MSVehicle* vehicle, ChangerIt& from, int direction);


    bool overlapWithHopped(ChangerIt target) const {
        MSVehicle* v1 = target->hoppedVeh;
        MSVehicle* v2 = veh(myCandi);
        if (v1 != 0 && v2 != 0) {
            return MSVehicle::overlap(v1, v2);
        }
        return false;
    }

    std::pair<MSVehicle* const, SUMOReal> getRealThisLeader(const ChangerIt& target) const;

    std::pair<MSVehicle* const, SUMOReal> getRealFollower(const ChangerIt& target) const;

    std::pair<MSVehicle* const, SUMOReal> getRealLeader(const ChangerIt& target) const;

protected:
    Changer   myChanger;

    ChangerIt myCandi;

    bool myAllowsSwap;

private:
    MSLaneChanger();

    MSLaneChanger(const MSLaneChanger&);

    MSLaneChanger& operator=(const MSLaneChanger&);
};


#endif

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