SUMOVTypeParameter.h

Go to the documentation of this file.

/****************************************************************************/
// Structure representing possible vehicle parameter
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 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 SUMOVTypeParameter_h
#define SUMOVTypeParameter_h


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

#include <config.h>

#endif

#include <string>
#include <map>
#include <utils/common/Parameterised.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/distribution/Distribution_Parameterized.h>

// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class OptionsCont;


// ===========================================================================
// value definitions
// ===========================================================================
const int VTYPEPARS_LENGTH_SET = 1;
const int VTYPEPARS_MINGAP_SET = 1 << 1;
const int VTYPEPARS_MAXSPEED_SET = 1 << 2;
const int VTYPEPARS_PROBABILITY_SET = 1 << 3;
const int VTYPEPARS_SPEEDFACTOR_SET = 1 << 4;
const int VTYPEPARS_EMISSIONCLASS_SET = 1 << 5;
const int VTYPEPARS_COLOR_SET = 1 << 6;
const int VTYPEPARS_VEHICLECLASS_SET = 1 << 7;
const int VTYPEPARS_WIDTH_SET = 1 << 8;
const int VTYPEPARS_HEIGHT_SET = 1 << 9;
const int VTYPEPARS_SHAPE_SET = 1 << 10;
const int VTYPEPARS_OSGFILE_SET = 1 << 11;
const int VTYPEPARS_IMGFILE_SET = 1 << 12;
const int VTYPEPARS_IMPATIENCE_SET = 1 << 13;
const int VTYPEPARS_LANE_CHANGE_MODEL_SET = 1 << 14;
const int VTYPEPARS_PERSON_CAPACITY = 1 << 15;
const int VTYPEPARS_BOARDING_DURATION = 1 << 16;
const int VTYPEPARS_CONTAINER_CAPACITY = 1 << 17;
const int VTYPEPARS_LOADING_DURATION = 1 << 18;
const int VTYPEPARS_CAR_FOLLOW_MODEL = 1 << 19;
const int VTYPEPARS_MAXSPEED_LAT_SET = 1 << 20;
const int VTYPEPARS_LATALIGNMENT_SET = 1 << 21;
const int VTYPEPARS_MINGAP_LAT_SET = 1 << 22;


// ===========================================================================
// struct definitions
// ===========================================================================
class SUMOVTypeParameter : public Parameterised {
public:
    SUMOVTypeParameter(const std::string& vtid, const SUMOVehicleClass vc = SVC_IGNORING);


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


    void write(OutputDevice& dev) const;

    void validateCFParameter() const;


    double getCFParam(const SumoXMLAttr attr, const double defaultValue) const;

    std::string getCFParamString(const SumoXMLAttr attr, const std::string defaultValue) const;

    double getLCParam(const SumoXMLAttr attr, const double defaultValue) const;

    double getJMParam(const SumoXMLAttr attr, const double defaultValue) const;


    std::string id;

    double length;
    double minGap;
    double maxSpeed;
    double defaultProbability;
    Distribution_Parameterized speedFactor;
    SUMOEmissionClass emissionClass;
    RGBColor color;
    SUMOVehicleClass vehicleClass;
    double impatience;
    int personCapacity;
    int containerCapacity;
    SUMOTime boardingDuration;
    SUMOTime loadingDuration;


    double width;

    double height;

    SUMOVehicleShape shape;

    std::string osgFile;

    std::string imgFile;


    SumoXMLTag cfModel;

    typedef std::map<SumoXMLAttr, std::string> SubParams;
    SubParams cfParameter;
    SubParams lcParameter;
    SubParams jmParameter;

    LaneChangeModel lcModel;

    double maxSpeedLat;
    LateralAlignment latAlignment;
    double minGapLat;

    int setParameter;


    mutable bool saved;

    mutable bool onlyReferenced;

    static double getDefaultAccel(const SUMOVehicleClass vc = SVC_IGNORING);

    static double getDefaultDecel(const SUMOVehicleClass vc = SVC_IGNORING);

    static double getDefaultEmergencyDecel(const SUMOVehicleClass vc = SVC_IGNORING);

    static double getDefaultImperfection(const SUMOVehicleClass vc = SVC_IGNORING);

    static const SUMOVTypeParameter& getDefault();

};

#endif

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