MSVehicleType.h

Go to the documentation of this file.

/****************************************************************************/
// The car-following model and parameter
/****************************************************************************/
// 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 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 <microsim/cfmodels/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>
#include <foreign/mersenne/MersenneTwister.h>


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


// ===========================================================================
// class definitions
// ===========================================================================
class MSVehicleType {
public:
    MSVehicleType(const SUMOVTypeParameter& parameter);


    virtual ~MSVehicleType();


    bool wasSet(int what) const {
        return (myParameter.setParameter & what) != 0;
    }



    const std::string& getID() const {
        return myParameter.id;
    }


    SUMOReal getLength() const {
        return myParameter.length;
    }


    SUMOReal getLengthWithGap() const {
        return myParameter.length + myParameter.minGap;
    }


    SUMOReal getMinGap() const {
        return myParameter.minGap;
    }


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


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


    inline LaneChangeModel getLaneChangeModel() const {
        return myParameter.lcModel;
    }


    SUMOReal getMaxSpeed() const {
        return myParameter.maxSpeed;
    }


    SUMOReal computeChosenSpeedDeviation(MTRand& rng, const SUMOReal minDevFactor = 0.2) const;


    SUMOReal getDefaultProbability() const {
        return myParameter.defaultProbability;
    }


    SUMOVehicleClass getVehicleClass() const {
        return myParameter.vehicleClass;
    }


    SUMOEmissionClass getEmissionClass() const {
        return myParameter.emissionClass;
    }


    const RGBColor& getColor() const {
        return myParameter.color;
    }


    SUMOReal getSpeedFactor() const {
        return myParameter.speedFactor;
    }


    SUMOReal getSpeedDeviation() const {
        return myParameter.speedDev;
    }


    SUMOReal getImpatience() const {
        return myParameter.impatience;
    }




    SUMOReal getWidth() const {
        return myParameter.width;
    }

    SUMOReal getHeight() const {
        return myParameter.height;
    }

    SUMOVehicleShape getGuiShape() const {
        return myParameter.shape;
    }

    std::string getOSGFile() const {
        return myParameter.osgFile;
    }


    std::string getImgFile() const {
        return myParameter.imgFile;
    }




    void setLength(const SUMOReal& length);


    void setMinGap(const SUMOReal& minGap);


    void setMaxSpeed(const SUMOReal& maxSpeed);


    void setVClass(SUMOVehicleClass vclass);


    void setDefaultProbability(const SUMOReal& prob);


    void setSpeedFactor(const SUMOReal& factor);


    void setSpeedDeviation(const SUMOReal& dev);


    void setEmissionClass(SUMOEmissionClass eclass);


    void setColor(const RGBColor& color);


    void setWidth(const SUMOReal& width);


    void setShape(SUMOVehicleShape shape);


    void setImpatience(const SUMOReal impatience);




    static MSVehicleType* build(SUMOVTypeParameter& from);


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


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


    const SUMOVTypeParameter& getParameter() const {
        return myParameter;
    }


private:
    SUMOVTypeParameter myParameter;

    MSCFModel* myCarFollowModel;

    const MSVehicleType* myOriginalType;


private:
    MSVehicleType(const MSVehicleType&);

    MSVehicleType& operator=(const MSVehicleType&);

};


#endif

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