SUMOVehicleParameter.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 SUMOVehicleParameter_h
#define SUMOVehicleParameter_h


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

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


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


// ===========================================================================
// value definitions
// ===========================================================================
const int VEHPARS_COLOR_SET = 1;
const int VEHPARS_VTYPE_SET = 2;
const int VEHPARS_DEPARTLANE_SET = 2 << 1;
const int VEHPARS_DEPARTPOS_SET = 2 << 2;
const int VEHPARS_DEPARTSPEED_SET = 2 << 3;
const int VEHPARS_PERIODNUM_SET = 2 << 4;
const int VEHPARS_PERIODFREQ_SET = 2 << 5;
const int VEHPARS_ROUTE_SET = 2 << 6;
const int VEHPARS_ARRIVALLANE_SET = 2 << 7;
const int VEHPARS_ARRIVALPOS_SET = 2 << 8;
const int VEHPARS_ARRIVALSPEED_SET = 2 << 9;
const int VEHPARS_LINE_SET = 2 << 10;
const int VEHPARS_FROM_TAZ_SET = 2 << 11;
const int VEHPARS_TO_TAZ_SET = 2 << 12;
const int VEHPARS_FORCE_REROUTE = 2 << 13;
const int VEHPARS_PERSON_CAPACITY_SET = 2 << 14;
const int VEHPARS_PERSON_NUMBER_SET = 2 << 15;
const int VEHPARS_CONTAINER_NUMBER_SET = 2 << 16;
const int VEHPARS_DEPARTPOSLAT_SET = 2 << 17;
const int VEHPARS_ARRIVALPOSLAT_SET = 2 << 18;
const int VEHPARS_VIA_SET = 2 << 19;

const int STOP_INDEX_END = -1;
const int STOP_INDEX_FIT = -2;

const int STOP_END_SET = 1;
const int STOP_START_SET = 2;
const int STOP_TRIGGER_SET = 2 << 1;
const int STOP_PARKING_SET = 2 << 2;
const int STOP_EXPECTED_SET = 2 << 3;
const int STOP_CONTAINER_TRIGGER_SET = 2 << 4;
const int STOP_EXPECTED_CONTAINERS_SET = 2 << 5;


// ===========================================================================
// enum definitions
// ===========================================================================
enum DepartDefinition {
    DEPART_GIVEN,
    DEPART_TRIGGERED,
    DEPART_CONTAINER_TRIGGERED,
    DEPART_NOW,
    DEPART_DEF_MAX
};


enum DepartLaneDefinition {
    DEPART_LANE_DEFAULT,
    DEPART_LANE_GIVEN,
    DEPART_LANE_RANDOM,
    DEPART_LANE_FREE,
    DEPART_LANE_ALLOWED_FREE,
    DEPART_LANE_BEST_FREE,
    DEPART_LANE_FIRST_ALLOWED,
    DEPART_LANE_DEF_MAX
};


enum DepartPosDefinition {
    DEPART_POS_DEFAULT,
    DEPART_POS_GIVEN,
    DEPART_POS_RANDOM,
    DEPART_POS_FREE,
    DEPART_POS_BASE,
    DEPART_POS_LAST,
    DEPART_POS_RANDOM_FREE,
    DEPART_POS_DEF_MAX
};


enum DepartPosLatDefinition {
    DEPART_POSLAT_DEFAULT,
    DEPART_POSLAT_GIVEN,
    DEPART_POSLAT_RIGHT,
    DEPART_POSLAT_CENTER,
    DEPART_POSLAT_LEFT,
    DEPART_POSLAT_RANDOM,
    DEPART_POSLAT_FREE,
    DEPART_POSLAT_RANDOM_FREE,
    DEPART_POSLAT_DEF_MAX
};


enum DepartSpeedDefinition {
    DEPART_SPEED_DEFAULT,
    DEPART_SPEED_GIVEN,
    DEPART_SPEED_RANDOM,
    DEPART_SPEED_MAX,
    DEPART_SPEED_DEF_MAX
};


enum ArrivalLaneDefinition {
    ARRIVAL_LANE_DEFAULT,
    ARRIVAL_LANE_GIVEN,
    ARRIVAL_LANE_CURRENT,
    ARRIVAL_LANE_DEF_MAX
};


enum ArrivalPosDefinition {
    ARRIVAL_POS_DEFAULT,
    ARRIVAL_POS_GIVEN,
    ARRIVAL_POS_RANDOM,
    ARRIVAL_POS_MAX,
    ARRIVAL_POS_DEF_MAX
};


enum ArrivalPosLatDefinition {
    ARRIVAL_POSLAT_DEFAULT,
    ARRIVAL_POSLAT_GIVEN,
    ARRIVAL_POSLAT_RIGHT,
    ARRIVAL_POSLAT_CENTER,
    ARRIVAL_POSLAT_LEFT,
    ARRIVAL_POSLAT_DEF_MAX
};


enum ArrivalSpeedDefinition {
    ARRIVAL_SPEED_DEFAULT,
    ARRIVAL_SPEED_GIVEN,
    ARRIVAL_SPEED_CURRENT,
    ARRIVAL_SPEED_DEF_MAX
};


// ===========================================================================
// struct definitions
// ===========================================================================
class SUMOVehicleParameter : public Parameterised {
public:
    SUMOVehicleParameter();

    ~SUMOVehicleParameter();

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


    void write(OutputDevice& dev, const OptionsCont& oc, const SumoXMLTag tag = SUMO_TAG_VEHICLE, const std::string& typeID = "") const;


    bool defaultOptionOverrides(const OptionsCont& oc, const std::string& optionName) const;




    static bool parseDepart(const std::string& val, const std::string& element, const std::string& id,
                            SUMOTime& depart, DepartDefinition& dd, std::string& error);


    static bool parseDepartLane(const std::string& val, const std::string& element, const std::string& id,
                                int& lane, DepartLaneDefinition& dld, std::string& error);


    static bool parseDepartPos(const std::string& val, const std::string& element, const std::string& id,
                               double& pos, DepartPosDefinition& dpd, std::string& error);


    static bool parseDepartPosLat(const std::string& val, const std::string& element, const std::string& id,
                                  double& pos, DepartPosLatDefinition& dpd, std::string& error);


    static bool parseDepartSpeed(const std::string& val, const std::string& element, const std::string& id,
                                 double& speed, DepartSpeedDefinition& dsd, std::string& error);


    static bool parseArrivalLane(const std::string& val, const std::string& element, const std::string& id,
                                 int& lane, ArrivalLaneDefinition& ald, std::string& error);


    static bool parseArrivalPos(const std::string& val, const std::string& element, const std::string& id,
                                double& pos, ArrivalPosDefinition& apd, std::string& error);


    static bool parseArrivalPosLat(const std::string& val, const std::string& element, const std::string& id,
                                   double& pos, ArrivalPosLatDefinition& apd, std::string& error);


    static bool parseArrivalSpeed(const std::string& val, const std::string& element, const std::string& id,
                                  double& speed, ArrivalSpeedDefinition& asd, std::string& error);


    static double interpretEdgePos(double pos, double maximumValue, SumoXMLAttr attr, const std::string& id);

    std::string id;

    std::string routeid;
    std::string vtypeid;
    mutable RGBColor color;



    SUMOTime depart;
    DepartDefinition departProcedure;
    int departLane;
    DepartLaneDefinition departLaneProcedure;
    double departPos;
    DepartPosDefinition departPosProcedure;
    double departPosLat;
    DepartPosLatDefinition departPosLatProcedure;
    double departSpeed;
    DepartSpeedDefinition departSpeedProcedure;



    int arrivalLane;
    ArrivalLaneDefinition arrivalLaneProcedure;
    double arrivalPos;
    ArrivalPosDefinition arrivalPosProcedure;
    double arrivalPosLat;
    ArrivalPosLatDefinition arrivalPosLatProcedure;
    double arrivalSpeed;
    ArrivalSpeedDefinition arrivalSpeedProcedure;



    int repetitionNumber;
    int repetitionsDone;
    SUMOTime repetitionOffset;
    double repetitionProbability;
    SUMOTime repetitionEnd;


    mutable std::string line;

    std::string fromTaz;

    std::string toTaz;

    struct Stop {
        std::string lane;
        std::string busstop;
        std::string containerstop;
        std::string parkingarea;
        std::string chargingStation;
        double startPos;
        double endPos;
        SUMOTime duration;
        SUMOTime until;
        bool triggered;
        bool containerTriggered;
        bool parking;
        std::set<std::string> awaitedPersons;
        std::set<std::string> awaitedContainers;
        std::multimap<std::string, double> accessPos;
        int index;
        int setParameter;

        void write(OutputDevice& dev) const;
    };

    mutable std::vector<Stop> stops;

    mutable std::vector<std::string> via;

    int personNumber;

    int containerNumber;

    mutable int setParameter;


};

#endif

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