MSVehicleType.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2017 German Aerospace Center (DLR) and others.
/****************************************************************************/
//
//   This program and the accompanying materials
//   are made available under the terms of the Eclipse Public License v2.0
//   which accompanies this distribution, and is available at
//   http://www.eclipse.org/legal/epl-v20.html
//
/****************************************************************************/
// The car-following model and parameter
/****************************************************************************/
#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/vehicle/SUMOVTypeParameter.h>
#include <utils/common/RGBColor.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.parametersSet & what) != 0;
    }



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


    int getNumericalID() const {
        return myIndex;
    }


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


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


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

    double getMinGapLat() const {
        return myParameter.minGapLat;
    }


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


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


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


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


    double computeChosenSpeedDeviation(std::mt19937* rng, const double minDev = -1.) const;


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


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


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


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


    const Distribution_Parameterized& getSpeedFactor() const {
        return myParameter.speedFactor;
    }


    SUMOTime getActionStepLength() const {
        return myParameter.actionStepLength;
    }


    double getActionStepLengthSecs() const {
        return myCachedActionStepLengthSecs;
    }


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




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

    double 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;
    }


    int getPersonCapacity() const {
        return myParameter.personCapacity;
    }


    int getContainerCapacity() const {
        return myParameter.containerCapacity;
    }

    SUMOTime getBoardingDuration() const {
        return myParameter.boardingDuration;
    }

    SUMOTime getLoadingDuration() const {
        return myParameter.loadingDuration;
    }

    double getMaxSpeedLat() const {
        return myParameter.maxSpeedLat;
    }

    LateralAlignment getPreferredLateralAlignment() const {
        return myParameter.latAlignment;
    }



    void setLength(const double& length);


    void setHeight(const double& height);


    void setMinGap(const double& minGap);


    void setMinGapLat(const double& minGapLat);

    void setMaxSpeed(const double& maxSpeed);

    void setMaxSpeedLat(const double& maxSpeedLat);

    void setVClass(SUMOVehicleClass vclass);


    void setDefaultProbability(const double& prob);


    void setSpeedFactor(const double& factor);


    void setSpeedDeviation(const double& dev);


    void setActionStepLength(const SUMOTime actionStepLength, bool resetActionOffset);


    void setEmissionClass(SUMOEmissionClass eclass);


    void setColor(const RGBColor& color);


    void setWidth(const double& width);


    void setShape(SUMOVehicleShape shape);

    void setImpatience(const double impatience);

    void setPreferredLateralAlignment(LateralAlignment latAlignment);




    static MSVehicleType* build(SUMOVTypeParameter& from);


    MSVehicleType* buildSingularType(const std::string& id) const;


    MSVehicleType* duplicateType(const std::string& id, bool persistent) const;


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


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

    void check();

private:
    SUMOVTypeParameter myParameter;

    double myCachedActionStepLengthSecs;

    bool myWarnedActionStepLengthTauOnce;

    const int myIndex;

    MSCFModel* myCarFollowModel;

    const MSVehicleType* myOriginalType;

    static int myNextIndex;


private:
    MSVehicleType(const MSVehicleType&);

    MSVehicleType& operator=(const MSVehicleType&);

};


#endif

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