MSVehicleType.h

Go to the documentation of this file.

/****************************************************************************/
// The car-following model and parameter
/****************************************************************************/
// 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 MSVehicleType_h
#define MSVehicleType_h


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

#include <cassert>
#include <map>
#include <string>
#include "MSCFModel.h"
#include <utils/common/SUMOTime.h>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/common/RandHelper.h>
#include <utils/common/SUMOVTypeParameter.h>
#include <utils/common/RGBColor.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
class BinaryInputDevice;
class MSCFModel;
class SUMOVTypeParameter;


// ===========================================================================
// class definitions
// ===========================================================================
class MSVehicleType {
public:
    MSVehicleType(const std::string& id, SUMOReal lengthWithGap,
                  SUMOReal minGap, SUMOReal maxSpeed,
                  SUMOReal prob, SUMOReal speedFactor,
                  SUMOReal speedDev, SUMOVehicleClass vclass,
                  SUMOEmissionClass emissionClass,
                  SUMOReal guiWidth, SUMOVehicleShape shape,
                  const std::string& lcModel,
                  const RGBColor& c) throw();


    virtual ~MSVehicleType() throw();




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


    SUMOReal getLength() const throw() {
        return myLength;
    }


    SUMOReal getLengthWithGap() const throw() {
        return myLength + myMinGap;
    }


    SUMOReal getMinGap() const throw() {
        return myMinGap;
    }


    inline const MSCFModel& getCarFollowModel() const throw() {
        return *myCarFollowModel;
    }


    inline MSCFModel& getCarFollowModel() throw() {
        return *myCarFollowModel;
    }


    SUMOReal getMaxSpeed() const throw() {
        return myMaxSpeed;
    }

    SUMOReal hasSpeedDeviation() const throw() {
        return mySpeedDev != 0.0 || mySpeedFactor != 1.0;
    }


    SUMOReal getMaxSpeedWithDeviation(SUMOReal referenceSpeed) const throw() {
        SUMOReal meanSpeed = mySpeedFactor * referenceSpeed;
        SUMOReal speedDev = mySpeedDev * meanSpeed;
        SUMOReal speed = MIN3(RandHelper::randNorm(meanSpeed, speedDev), meanSpeed + 2*speedDev, myMaxSpeed);
        return MAX3((SUMOReal)0.0, speed, meanSpeed - 2*speedDev);
    }


    SUMOReal getDefaultProbability() const throw() {
        return myDefaultProbability;
    }


    SUMOVehicleClass getVehicleClass() const throw() {
        return myVehicleClass;
    }


    SUMOEmissionClass getEmissionClass() const throw() {
        return myEmissionClass;
    }


    const RGBColor& getColor() const throw() {
        return myColor;
    }


    SUMOReal getSpeedFactor() const throw() {
        return mySpeedFactor;
    }


    SUMOReal getSpeedDeviation() const throw() {
        return mySpeedDev;
    }




    SUMOReal getGuiWidth() const throw() {
        return myWidth;
    }

    SUMOVehicleShape getGuiShape() const throw() {
        return myShape;
    }






    void saveState(std::ostream& os);




    void setLength(const SUMOReal& length) throw();


    void setMinGap(const SUMOReal& minGap) throw();


    void setMaxSpeed(const SUMOReal& maxSpeed) throw();


    void setVClass(SUMOVehicleClass vclass) throw();


    void setDefaultProbability(const SUMOReal& prob) throw();


    void setSpeedFactor(const SUMOReal& factor) throw();


    void setSpeedDeviation(const SUMOReal& dev) throw();


    void setEmissionClass(SUMOEmissionClass eclass) throw();


    void setColor(const RGBColor& color) throw();


    void setWidth(const SUMOReal& width) throw();


    void setShape(SUMOVehicleShape shape) throw();




    static MSVehicleType* build(SUMOVTypeParameter& from) throw(ProcessError);


    static MSVehicleType* build(const std::string& id, const MSVehicleType* from) throw();


    static SUMOReal get(const SUMOVTypeParameter::CFParams& from, SumoXMLAttr attr, SUMOReal defaultValue);


    bool amVehicleSpecific() const throw() {
        return myOriginalType!=0;
    }


private:
    std::string myID;

    SUMOReal myLength;

    SUMOReal myMinGap;

    SUMOReal myMaxSpeed;

    SUMOReal myDefaultProbability;

    SUMOReal mySpeedFactor;

    SUMOReal mySpeedDev;

    MSCFModel* myCarFollowModel;

    std::string myLaneChangeModel;

    SUMOEmissionClass myEmissionClass;

    RGBColor myColor;

    SUMOVehicleClass myVehicleClass;



    SUMOReal myWidth;

    SUMOVehicleShape myShape;


    const MSVehicleType* myOriginalType;


private:
    MSVehicleType(const MSVehicleType&);

    MSVehicleType& operator=(const MSVehicleType&);

};


#endif

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