GNECalibratorFlow.h

Go to the documentation of this file.

/****************************************************************************/
// Flow 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 GNECalibratorFlow_h
#define GNECalibratorFlow_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/RGBColor.h>

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

class GNECalibrator;

// ===========================================================================
// class definitions
// ===========================================================================
class GNECalibratorFlow {
public:

    enum TypeOfFlow {
        GNE_CALIBRATORFLOW_INVALID,
        GNE_CALIBRATORFLOW_VEHSPERHOUR,
        GNE_CALIBRATORFLOW_PERIOD,
        GNE_CALIBRATORFLOW_PROBABILITY
    };

    GNECalibratorFlow(GNECalibrator* calibratorParent);

    GNECalibratorFlow(GNECalibrator* calibratorParent, std::string flowID, std::string vehicleType, std::string route, const RGBColor& color, std::string departLane,
                      std::string departPos, std::string departSpeed, std::string arrivalLane, std::string arrivalPos, std::string arrivalSpeed, std::string line,
                      int personNumber, int containerNumber, bool reroute, std::string departPosLat, std::string arrivalPosLat, double begin, double end,
                      double vehsPerHour, double period, double probability, int number);

    ~GNECalibratorFlow();

    GNECalibrator* getCalibratorParent() const;

    SumoXMLTag getTag() const;

    const std::string& getFlowID() const;

    const std::string& getVehicleType() const;

    const std::string& getRoute() const;

    const RGBColor& getColor() const;

    const std::string& getDepartLane() const;

    const std::string& getDepartPos() const;

    const std::string& getDepartSpeed() const;

    const std::string& getArrivalLane() const;

    const std::string& getArrivalPos() const;

    const std::string& getArrivalSpeed() const;

    const std::string& getLine() const;

    int getPersonNumber() const;

    int getContainerNumber() const;

    bool getReroute() const;

    std::string getDepartPosLat() const;

    std::string getArrivalPosLat() const;

    double getBegin() const;

    double getEnd() const;

    double getVehsPerHour() const;

    double getPeriod() const;

    double getProbability() const;

    int getNumber() const;

    TypeOfFlow getFlowType() const;

    bool setFlowID(std::string ID);

    bool setVehicleType(std::string vehicleType);

    bool setRoute(std::string route);

    bool setColor(const RGBColor& color);

    bool setColor(std::string = "black");

    bool setDepartLane(std::string departLane = "first");

    bool setDepartPos(std::string departPos = "base");

    bool setDepartSpeed(std::string departSpeed = "0");

    bool setArrivalLane(std::string arrivalLane = "current");

    bool setArrivalPos(std::string arrivalPos = "max");

    bool setArrivalSpeed(std::string arrivalSpeed = "current");

    bool setLine(std::string line = "");

    bool setPersonNumber(int personNumber = 0);

    bool setPersonNumber(std::string personNumber = "0");

    bool setContainerNumber(int containerNumber = 0);

    bool setContainerNumber(std::string containerNumber = "0");

    bool setReroute(bool value);

    bool setReroute(std::string value);

    bool setDepartPosLat(std::string departPosLat = "center");

    bool setArrivalPosLat(std::string arrivalPosLat = "");


    bool setBegin(double begin);

    bool setBegin(std::string begin);

    bool setEnd(double end);

    bool setEnd(std::string end);

    bool setVehsPerHour(double vehsPerHour);

    bool setVehsPerHour(std::string vehsPerHour);

    bool setPeriod(double period);

    bool setPeriod(std::string period);

    bool setProbability(double probability);

    bool setProbability(std::string probability);

    bool setNumber(int number);

    bool setNumber(std::string number);

    bool setTypeOfFlow(TypeOfFlow type);

    bool operator==(const GNECalibratorFlow& calibratorFlow) const;

private:
    GNECalibrator* myCalibratorParent;

    std::string myFlowID;

    std::string myVehicleType;

    std::string myRoute;

    RGBColor myColor;

    std::string myDepartLane;

    std::string myDepartPos;

    std::string myDepartSpeed;

    std::string myArrivalLane;

    std::string myArrivalPos;

    std::string myArrivalSpeed;

    std::string myLine;

    int myPersonNumber;

    int myContainerNumber;

    bool myReroute;

    std::string myDepartPosLat;

    std::string myArrivalPosLat;

    double myBegin;

    double myEnd;

    double myVehsPerHour;

    double myPeriod;

    double myProbability;

    int myNumber;

    TypeOfFlow myTypeOfFlow;
};

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