MSCFModel.h

Go to the documentation of this file.

/****************************************************************************/
// The car-following model abstraction
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program 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 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSCFModel_h
#define MSCFModel_h

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

#include <cassert>
#include <string>
#include <utils/common/StdDefs.h>
#include <utils/common/FileHelpers.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSVehicleType;
class MSVehicle;
class MSLane;


// ===========================================================================
// class definitions
// ===========================================================================
class MSCFModel {
public:

    class VehicleVariables {
    };

    MSCFModel(const MSVehicleType* vtype, SUMOReal accel, SUMOReal decel, SUMOReal headwayTime);


    virtual ~MSCFModel();



    virtual SUMOReal moveHelper(MSVehicle* const veh, SUMOReal vPos) const;


    virtual SUMOReal freeSpeed(const MSVehicle* const veh, SUMOReal speed, SUMOReal seen, SUMOReal maxSpeed) const {
        return followSpeed(veh, speed, seen, maxSpeed, 0);
    }


    virtual SUMOReal followSpeed(const MSVehicle* const veh, SUMOReal speed, SUMOReal gap2pred, SUMOReal predSpeed, SUMOReal predMaxDecel) const = 0;


    virtual SUMOReal stopSpeed(const MSVehicle* const veh, SUMOReal gap2pred) const = 0;


    virtual SUMOReal interactionGap(const MSVehicle* const veh, SUMOReal vL) const;


    virtual void saveState(std::ostream& os);


    virtual int getModelID() const = 0;


    virtual MSCFModel* duplicate(const MSVehicleType* vtype) const = 0;


    virtual VehicleVariables* createVehicleVariables() const {
        return 0;
    }



    virtual SUMOReal getMaxAccel() const {
        return myAccel;
    }


    virtual SUMOReal getMaxDecel() const {
        return myDecel;
    }


    virtual SUMOReal getImperfection() const {
        return -1;
    }


    virtual SUMOReal getHeadwayTime() const {
        return myHeadwayTime;
    }




    void leftVehicleVsafe(const MSVehicle* const ego, const MSVehicle* const neigh, SUMOReal& vSafe) const;


    SUMOReal maxNextSpeed(SUMOReal speed) const;


    SUMOReal brakeGap(SUMOReal speed) const;


    SUMOReal getSecureGap(const SUMOReal speed, const SUMOReal leaderSpeed, const SUMOReal leaderMaxDecel) const {
        const int leaderSteps = int(leaderSpeed / ACCEL2SPEED(leaderMaxDecel));
        const SUMOReal leaderBreak = SPEED2DIST(leaderSteps * leaderSpeed - ACCEL2SPEED(leaderMaxDecel) * leaderSteps * (leaderSteps+1) / 2);
        return MAX2((SUMOReal) 0, brakeGap(speed) - leaderBreak);
    }


    SUMOReal getSpeedAfterMaxDecel(SUMOReal v) const {
        return MAX2((SUMOReal) 0, v - (SUMOReal) ACCEL2SPEED(myDecel));
    }



    virtual void setMaxAccel(SUMOReal accel) {
        myAccel = accel;
    }


    virtual void setMaxDecel(SUMOReal decel) {
        myDecel = decel;
    }


    virtual void setImperfection(SUMOReal imperfection) {
        UNUSED_PARAMETER(imperfection);
    }


    virtual void setHeadwayTime(SUMOReal headwayTime) {
        myHeadwayTime = headwayTime;
    }


protected:
    const MSVehicleType* myType;

    SUMOReal myAccel;

    SUMOReal myDecel;

    SUMOReal myHeadwayTime;
};


#endif  /* MSCFModel_h */