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 2001-2010 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:
    MSCFModel(const MSVehicleType* vtype, SUMOReal decel) throw();


    virtual ~MSCFModel() throw();



    virtual SUMOReal moveHelper(MSVehicle * const veh, const MSLane * const lane, SUMOReal vPos) const throw() = 0;


    virtual SUMOReal ffeV(const MSVehicle * const veh, SUMOReal speed, SUMOReal gap2pred, SUMOReal predSpeed) const throw() = 0;


    virtual SUMOReal ffeV(const MSVehicle * const veh, SUMOReal gap2pred, SUMOReal predSpeed) const throw() = 0;


    virtual SUMOReal ffeV(const MSVehicle * const veh, const MSVehicle * const pred) const throw() = 0;


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


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


    virtual bool hasSafeGap(SUMOReal speed, SUMOReal gap, SUMOReal predSpeed, SUMOReal laneMaxSpeed) const throw() = 0;


    virtual SUMOReal getMaxAccel(SUMOReal v) const throw() = 0;


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


    virtual int getModelID() const throw() = 0;




    virtual SUMOReal getTau() const throw() {
        return 1.;
    }




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


    SUMOReal maxNextSpeed(SUMOReal speed) const throw();


    SUMOReal getMaxDecel() const throw() {
        return myDecel;
    }


    SUMOReal brakeGap(SUMOReal speed) const throw();


    SUMOReal getSecureGap(const SUMOReal speed, const SUMOReal leaderSpeedAfterDecel) const throw() {
        const SUMOReal speedDiff = speed - leaderSpeedAfterDecel;
        return speedDiff * speedDiff / getMaxDecel() + speed * getTau();
    }


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


protected:
    const MSVehicleType* myType;

    SUMOReal myDecel;

    SUMOReal myInverseTwoDecel;


};


#endif  /* MSCFModel_h */