SUMOVTypeParameter.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Structure representing possible vehicle parameter
/****************************************************************************/
#pragma once
#include <config.h>
 
#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/common/LinearApproxHelpers.h>
#include <utils/distribution/Distribution_Parameterized.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class OptionsCont;
 
 
// ===========================================================================
// value definitions
// ===========================================================================
const long long int VTYPEPARS_LENGTH_SET = 1;
const long long int VTYPEPARS_MINGAP_SET = 1 << 1;
const long long int VTYPEPARS_MAXSPEED_SET = 1 << 2;
const long long int VTYPEPARS_PROBABILITY_SET = 1 << 3;
const long long int VTYPEPARS_SPEEDFACTOR_SET = 1 << 4;
const long long int VTYPEPARS_EMISSIONCLASS_SET = 1 << 5;
const long long int VTYPEPARS_COLOR_SET = 1 << 6;
const long long int VTYPEPARS_VEHICLECLASS_SET = 1 << 7;
const long long int VTYPEPARS_WIDTH_SET = 1 << 8;
const long long int VTYPEPARS_HEIGHT_SET = 1 << 9;
const long long int VTYPEPARS_SHAPE_SET = 1 << 10;
const long long int VTYPEPARS_OSGFILE_SET = 1 << 11;
const long long int VTYPEPARS_IMGFILE_SET = 1 << 12;
const long long int VTYPEPARS_IMPATIENCE_SET = 1 << 13;
const long long int VTYPEPARS_LANE_CHANGE_MODEL_SET = 1 << 14;
const long long int VTYPEPARS_PERSON_CAPACITY = 1 << 15;
const long long int VTYPEPARS_BOARDING_DURATION = 1 << 16;
const long long int VTYPEPARS_CONTAINER_CAPACITY = 1 << 17;
const long long int VTYPEPARS_LOADING_DURATION = 1 << 18;
const long long int VTYPEPARS_CAR_FOLLOW_MODEL = 1 << 19;
const long long int VTYPEPARS_MAXSPEED_LAT_SET = 1 << 20;
const long long int VTYPEPARS_LATALIGNMENT_SET = 1 << 21;
const long long int VTYPEPARS_MINGAP_LAT_SET = 1 << 22;
const long long int VTYPEPARS_ACTIONSTEPLENGTH_SET = 1 << 23;
const long long int VTYPEPARS_DESIRED_MAXSPEED_SET = 1 << 24;
const long long int VTYPEPARS_CARRIAGE_LENGTH_SET = 1 << 25;
const long long int VTYPEPARS_LOCOMOTIVE_LENGTH_SET = 1 << 26;
const long long int VTYPEPARS_CARRIAGE_GAP_SET = 1 << 27;
const long long int VTYPEPARS_CARRIAGE_DOORS_SET = 1 << 28;
const long long int VTYPEPARS_MANEUVER_ANGLE_TIMES_SET = 1 << 29;
const long long int VTYPEPARS_FRONT_SEAT_POS_SET = 1 << 30;
const long long int VTYPEPARS_SCALE_SET = (long long int)1 << 31;
const long long int VTYPEPARS_MASS_SET = (long long int)1 << 32;
const long long int VTYPEPARS_TTT_SET = (long long int)1 << 33;
const long long int VTYPEPARS_TTT_BIDI_SET = (long long int)1 << 34;
const long long int VTYPEPARS_SEATING_WIDTH_SET = (long long int)1 << 35;
const long long int VTYPEPARS_SPEEDFACTOR_PREMATURE_SET = (long long int)1 << 36;
const long long int VTYPEPARS_PARKING_BADGES_SET = (long long int)1 << 37;
const long long int VTYPEPARS_BOARDING_FACTOR_SET = (long long int)1 << 38;
 
 
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DEFAULT = -1;
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DECEL = -2;
 
 
// ===========================================================================
// enum definitions
// ===========================================================================
enum class LatAlignmentDefinition {
    DEFAULT,
    GIVEN,
    RIGHT,
    CENTER,
    ARBITRARY,
    NICE,
    COMPACT,
    LEFT
};
 
 
// ===========================================================================
// struct definitions
// ===========================================================================
class SUMOVTypeParameter : public Parameterised {
 
public:
    struct VClassDefaultValues {
        VClassDefaultValues(SUMOVehicleClass vClass);

        double length;

        double minGap;

        double minGapLat;

        double maxSpeed;

        double desiredMaxSpeed;

        double width;

        double height;

        SUMOVehicleShape shape;

        SUMOEmissionClass emissionClass;

        double mass;

        Distribution_Parameterized speedFactor;

        int personCapacity;

        int containerCapacity;

        std::string osgFile;

        double carriageLength;

        double locomotiveLength;

        int carriageDoors;

        double carriageDoorWidth;

        double maxPlatformDistance;

        LatAlignmentDefinition latAlignmentProcedure;
 
    private:
        VClassDefaultValues();
    };

    SUMOVTypeParameter(const std::string& vtid, const SUMOVehicleClass vc = SVC_IGNORING);

    virtual ~SUMOVTypeParameter() {};

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

    void write(OutputDevice& dev) const;

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

    std::vector<double> getCFValueTable(SumoXMLAttr attr) const;

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

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

    std::string getLCParamString(const SumoXMLAttr attr, const std::string& defaultValue) const;

    typedef std::map<SumoXMLAttr, std::string> SubParams;

    const SubParams& getLCParams() const;

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

    std::string getJMParamString(const SumoXMLAttr attr, const std::string defaultValue) const;
 
    void cacheParamRestrictions(const std::vector<std::string>& restrictionKeys);

    void initRailVisualizationParameters(const std::string fileName = "");

    std::string id;

    double length;

    double minGap;

    double maxSpeed;

    double desiredMaxSpeed;

    SUMOTime actionStepLength;

    double defaultProbability;

    Distribution_Parameterized speedFactor;

    SUMOEmissionClass emissionClass;

    double mass;

    RGBColor color;

    SUMOVehicleClass vehicleClass;

    double impatience;

    int personCapacity;

    int containerCapacity;

    SUMOTime boardingDuration;

    SUMOTime loadingDuration;

    double scale;


    double width;

    double height;

    SUMOVehicleShape shape;

    std::string osgFile;

    std::string imgFile;

    std::vector<std::string> carriageImages;
 

    SumoXMLTag cfModel;

    SubParams cfParameter;

    SubParams lcParameter;

    SubParams jmParameter;

    LaneChangeModel lcModel;

    double maxSpeedLat;

    double latAlignmentOffset;

    LatAlignmentDefinition latAlignmentProcedure;

    double minGapLat;

    double scaleVisual;

    double carriageLength;

    double locomotiveLength;

    double carriageGap;

    int carriageDoors;

    double carriageDoorWidth;

    double maxPlatformDistance;

    SUMOTime timeToTeleport;

    SUMOTime timeToTeleportBidi;

    double speedFactorPremature;

    double frontSeatPos;

    double seatingWidth;

    std::vector<std::string> parkingBadges;

    double boardingFactor;

    long long int parametersSet;

    mutable bool saved;

    bool onlyReferenced;

    std::vector<double> paramRestrictions;

    static std::set<SumoXMLAttr> AllowedJMAttrs;

    inline double getLength() const {
        return length;
    }

    static double getDefaultAccel(const SUMOVehicleClass vc = SVC_IGNORING);

    static double getDefaultDecel(const SUMOVehicleClass vc = SVC_IGNORING);

    static double getDefaultEmergencyDecel(const SUMOVehicleClass vc, double decel, double defaultOption);

    static double getDefaultImperfection(const SUMOVehicleClass vc = SVC_IGNORING);

    static const SUMOVTypeParameter& getDefault();

    static bool parseLatAlignment(const std::string& val, double& lao, LatAlignmentDefinition& lad);
 
    static inline bool isValidLatAlignment(const std::string& val) {
        double lao;
        LatAlignmentDefinition lad;
        return SUMOVTypeParameter::parseLatAlignment(val, lao, lad);
    }

    // XXX: does not include valid float strings
    static inline std::vector<std::string> getLatAlignmentStrings() {
        std::vector<std::string> result;
        result.push_back("right");
        result.push_back("center");
        result.push_back("arbitrary");
        result.push_back("nice");
        result.push_back("compact");
        result.push_back("left");
        return result;
    }

    std::map<int, std::pair<SUMOTime, SUMOTime>>  myManoeuverAngleTimes;

    void setManoeuverAngleTimes(const SUMOVehicleClass vclass);

    SUMOTime getEntryManoeuvreTime(const int angle) const;

    SUMOTime getExitManoeuvreTime(const int angle) const;

    std::string getManoeuverAngleTimesS() const;

    SUMOTime getTimeToTeleport(SUMOTime defaultValue) const;

    SUMOTime getTimeToTeleportBidi(SUMOTime defaultValue) const;

    static LinearApproxHelpers::LinearApproxMap getDefaultMaxAccelProfile(const SUMOVehicleClass vc, double maxAccel);

    static LinearApproxHelpers::LinearApproxMap getDefaultDesAccelProfile(const SUMOVehicleClass vc, double desAccel);

    LinearApproxHelpers::LinearApproxMap getCFProfile(const SumoXMLAttr attr, const LinearApproxHelpers::LinearApproxMap& defaultProfile) const;

    std::vector<std::pair<double, double> > createCFProfile(const SumoXMLAttr attr, const std::string profile) const;
};