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


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

#include "GNEAdditional.h"

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

class GNERouteProbe;
class GNECalibratorFlow;
class GNECalibratorRoute;

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

public:

    GNECalibrator(const std::string& id, GNEViewNet* viewNet, GNEEdge* edge, double pos, double frequency, const std::string& name, const std::string& output);

    GNECalibrator(const std::string& id, GNEViewNet* viewNet, GNELane* lane, double pos, double frequency, const std::string& name, const std::string& output);

    ~GNECalibrator();

    void openAdditionalDialog();


    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
     */
    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);

    std::string getPopUpID() const;

    std::string getHierarchyName() const;

protected:
    GNEEdge* myEdge;

    GNELane* myLane;

    double myPositionOverLane;

    double myFrequency;

    std::string myOutput;

    GNERouteProbe* myRouteProbe;

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

    GNECalibrator(const GNECalibrator&) = delete;

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

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