GNECalibrator.h

Go to the documentation of this file.

/****************************************************************************/
/****************************************************************************/
// 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 GNECalibrator_h
#define GNECalibrator_h


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

#include "GNEAdditional.h"

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

class GNERouteProbe;

// ===========================================================================
// class definitions
// ===========================================================================
class GNECalibrator : public GNEAdditional {
public:

    class GNECalibratorFlow {

    public:
        GNECalibratorFlow(GNECalibrator* calibratorParent, std::string type, std::string route);

        GNECalibratorFlow(GNECalibrator* calibratorParent, std::string type, std::string route, std::string 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, SUMOReal begin, SUMOReal end,
                          SUMOReal vehsPerHour, SUMOReal period, SUMOReal probability, int number);

        ~GNECalibratorFlow();

        GNECalibrator* getCalibratorParent() const;

        const std::string& getType() const;

        const std::string& getRoute() const;

        const std::string& 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;

        SUMOReal getBegin() const;

        SUMOReal getEnd() const;

        SUMOReal getVehsPerHour() const;

        SUMOReal getPeriod() const;

        SUMOReal getProbability() const;

        int getNumber() const;

        bool setType(std::string type);

        bool setRoute(std::string route);

        bool setColor(std::string color);

        bool setDepartLane(std::string departLane);

        bool setDepartPos(std::string departPos);

        bool setDepartSpeed(std::string departSpeed);

        bool setArrivalLane(std::string arrivalLane);

        bool setArrivalPos(std::string arrivalPos);

        bool setArrivalSpeed(std::string arrivalSpeed);

        bool setLine(std::string line);

        bool setPersonNumber(int personNumber);

        bool setContainerNumber(int containerNumber);

        bool setBegin(SUMOReal begin);

        bool setEnd(SUMOReal end);

        bool setVehsPerHour(SUMOReal vehsPerHour);

        bool setPeriod(SUMOReal period);

        bool setProbability(SUMOReal probability);

        bool setNumber(int number);

    private:
        GNECalibrator* myCalibratorParent;

        std::string myType;

        std::string myRoute;

        std::string 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;

        SUMOReal myBegin;

        SUMOReal myEnd;

        SUMOReal myVehsPerHour;

        SUMOReal myPeriod;

        SUMOReal myProbability;

        int myNumber;

        GNECalibratorFlow(const GNECalibratorFlow&);

        GNECalibratorFlow& operator=(const GNECalibratorFlow&);
    };

    GNECalibrator(const std::string& id, GNEEdge* edge, GNEViewNet* viewNet, SUMOReal pos, SUMOReal frequency,
                  const std::string& output, const std::vector<GNECalibrator::GNECalibratorFlow*>& flowValues);

    ~GNECalibrator();

    void moveAdditionalGeometry(SUMOReal, SUMOReal);

    void commmitAdditionalGeometryMoved(SUMOReal, SUMOReal, GNEUndoList*);

    void updateGeometry();

    Position getPositionInView() const;

    void openAdditionalDialog();

    void writeAdditional(OutputDevice& device) const;

    std::vector<GNECalibrator::GNECalibratorFlow*> getFlowValues() const;

    void setFlowValues(std::vector<GNECalibrator::GNECalibratorFlow*> calibratorFlowValues);

    void insertFlow(GNECalibratorFlow* flow);

    void removeFlow(GNECalibratorFlow* flow);

    const std::string& getParentName() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getAttribute(SumoXMLAttr key) const;

    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);

    /* @brief method for checking if the key and their correspond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value asociated to key key
     * @return true if the value is valid, false in other case
     */
    bool isValid(SumoXMLAttr key, const std::string& value);

protected:
    SUMOReal myFrequency;

    std::string myOutput;

    GNERouteProbe* myRouteProbe;

    std::vector<GNECalibratorFlow*> myFlowValues;

private:
    void setAttribute(SumoXMLAttr key, const std::string& value);

    GNECalibrator(const GNECalibrator&);

    GNECalibrator& operator=(const GNECalibrator&);
};

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