GNECalibratorVehicleType.h

Go to the documentation of this file.

/****************************************************************************/
// VehicleType used by GNECalibrators
/****************************************************************************/
// 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 GNECalibratorVehicleType_h
#define GNECalibratorVehicleType_h


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

#include <utils/common/UtilExceptions.h>
#include <utils/xml/SUMOXMLDefinitions.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/common/RGBColor.h>

// ===========================================================================
// class declaration
// ===========================================================================

class GNECalibrator;

// ===========================================================================
// class definitions
// ===========================================================================
class GNECalibratorVehicleType {
public:
    GNECalibratorVehicleType(GNECalibrator* calibratorParent);

    GNECalibratorVehicleType(GNECalibrator* calibratorParent, std::string vehicleTypeID,
                             double accel, double decel, double sigma, double tau, double length, double minGap,
                             double maxSpeed, double speedFactor, double speedDev, const RGBColor& color,
                             SUMOVehicleClass vClass, const std::string& emissionClass, SUMOVehicleShape shape,
                             double width, const std::string& filename, double impatience, const std::string& laneChangeModel,
                             const std::string& carFollowModel, int personCapacity, int containerCapacity, double boardingDuration,
                             double loadingDuration, const std::string& latAlignment, double minGapLat, double maxSpeedLat);

    ~GNECalibratorVehicleType();

    GNECalibrator* getCalibratorParent() const;

    SumoXMLTag getTag() const;

    std::string getVehicleTypeID() const;

    double getAccel() const;

    double getDecel() const;

    double getSigma() const;

    double getTau() const;

    double getLength() const;

    double getMinGap() const;

    double getMaxSpeed() const;

    double getSpeedFactor() const;

    double getSpeedDev() const;

    const RGBColor& getColor() const;

    SUMOVehicleClass getVClass() const;

    std::string getEmissionClass() const;

    SUMOVehicleShape getShape() const;

    double getWidth() const;

    std::string getFilename() const;

    double getImpatience() const;

    std::string getLaneChangeModel() const;

    std::string getCarFollowModel() const;

    int getPersonCapacity() const;

    int getContainerCapacity() const;

    double getBoardingDuration() const;

    double getLoadingDuration() const;

    std::string getLatAlignment() const;

    double getMinGapLat() const;

    double getMaxSpeedLat() const;

    bool setVehicleTypeID(std::string vehicleTypeID);

    bool setAccel(double accel = 2.6);

    bool setAccel(std::string accel);

    bool setDecel(double decel = 4.5);

    bool setDecel(std::string decel);

    bool setSigma(double sigma = 0.5);

    bool setSigma(std::string sigma);

    bool setTau(double tau = 1.0);

    bool setTau(std::string tau);

    bool setLength(double length = 5.0);

    bool setLength(std::string length);

    bool setMinGap(double minGap = 2.5);

    bool setMinGap(std::string minGap);

    bool setMaxSpeed(double maxSpeed = 70.0);

    bool setMaxSpeed(std::string maxSpeed);

    bool setSpeedFactor(double speedFactor = 1.0);

    bool setSpeedFactor(std::string speedFactor);

    bool setSpeedDev(double speedDev = 0.0);

    bool setSpeedDev(std::string speedDev);

    bool setColor(const RGBColor& color);

    bool setColor(std::string color = "1,1,0");

    bool setVClass(SUMOVehicleClass vClass = SVC_PRIVATE);

    bool setVClass(std::string vClass);

    bool setEmissionClass(std::string emissionClass = "P_7_7");

    bool setShape(std::string shape);

    bool setShape(SUMOVehicleShape shape = SVS_PASSENGER);

    bool setWidth(double width = 2.0);

    bool setWidth(std::string width);

    bool setFilename(std::string filename = "");

    bool setImpatience(double impatience = 0.0);

    bool setImpatience(std::string impatience);

    bool setLaneChangeModel(std::string laneChangeModel = "LC2013");

    bool setCarFollowModel(std::string carFollowModel = "Krauss");

    bool setPersonCapacity(int personCapacity = 4);

    bool setPersonCapacity(std::string personCapacity);

    bool setContainerCapacity(int containerCapacity = 0);

    bool setContainerCapacity(std::string containerCapacity);

    bool setBoardingDuration(double boardingDuration = 0.5);

    bool setBoardingDuration(std::string boardingDuration);

    bool setLoadingDuration(double loadingDuration = 90.0);

    bool setLoadingDuration(std::string loadingDuration);

    bool setLatAlignment(std::string latAlignment = "center");

    bool setMinGapLat(double minGapLat = 0.12);

    bool setMinGapLat(std::string minGapLat);

    bool setMaxSpeedLat(double maxSpeedLat = 1.0);

    bool setMaxSpeedLat(std::string maxSpeedLat);

    bool operator==(const GNECalibratorVehicleType& calibratorVehicleType) const;

private:
    GNECalibrator* myCalibratorParent;

    std::string myVehicleTypeID;

    double myAccel;

    double myDecel;

    double mySigma;

    double myTau;

    double myLength;

    double myMinGap;

    double myMaxSpeed;

    double mySpeedFactor;

    double mySpeedDev;

    RGBColor myColor;

    SUMOVehicleClass myVClass;

    std::string myEmissionClass;

    SUMOVehicleShape myShape;

    double myWidth;

    std::string myFilename;

    double myImpatience;

    std::string myLaneChangeModel;

    std::string myCarFollowModel;

    int myPersonCapacity;

    int myContainerCapacity;

    double myBoardingDuration;

    double myLoadingDuration;

    std::string myLatAlignment;

    double myMinGapLat;

    double myMaxSpeedLat;
};

#endif
/****************************************************************************/