GNECalibratorFlow.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// Flow used by GNECalibrators
/****************************************************************************/
#ifndef GNECalibratorFlow_h
#define GNECalibratorFlow_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

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

#include "GNEAdditional.h"

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

class GNECalibrator;
class GNECalibratorDialog;
class GNECalibratorVehicleType;
class GNECalibratorRoute;

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

public:
    GNECalibratorFlow(GNEAdditional* calibratorParent);

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

    ~GNECalibratorFlow();


    void moveGeometry(const Position& oldPos, const Position& offset);

    void commitGeometryMoving(const Position& oldPos, GNEUndoList* undoList);

    void updateGeometry(bool updateGrid);

    Position getPositionInView() 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
    * @param[in] net optionally the GNENet to inform about gui updates
    */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);

    /* @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
    */
    bool isValid(SumoXMLAttr key, const std::string& value);

    std::string getPopUpID() const;

    std::string getHierarchyName() const;

protected:
    GNEAdditional* myVehicleType;

    GNEAdditional* myRoute;

    std::string myVehsPerHour;

    std::string mySpeed;

    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;

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

    GNECalibratorFlow(const GNECalibratorFlow&) = delete;

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

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