GNECalibrator.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Calibrator over edge or lane
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "GNEAdditional.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNERouteProbe;
class GNECalibratorFlow;
class GNERoute;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNECalibrator : public GNEAdditional, public Parameterised {
 
public:
    GNECalibrator(SumoXMLTag tag, GNENet* net);
 
    GNECalibrator(const std::string& id, GNENet* net, const std::string& filename, GNEEdge* edge, double pos, SUMOTime frequency, const std::string& name,
                  const std::string& output, const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
 
    GNECalibrator(const std::string& id, GNENet* net, const std::string& filename, GNEEdge* edge, double pos, SUMOTime frequency, const std::string& name,
                  const std::string& output, GNEAdditional* routeProbe, const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
 
    GNECalibrator(const std::string& id, GNENet* net, const std::string& filename, GNELane* lane, double pos, SUMOTime frequency, const std::string& name,
                  const std::string& output, const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
 
    GNECalibrator(const std::string& id, GNENet* net, const std::string& filename, GNELane* lane, double pos, SUMOTime frequency, const std::string& name,
                  const std::string& output, GNEAdditional* routeProbe, const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters);
 
    ~GNECalibrator();
 
 
    GNEMoveElement* getMoveElement() const override;
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
 
 
    void writeAdditional(OutputDevice& device) const override;
 
    bool isAdditionalValid() const override;
 
    std::string getAdditionalProblem() const override;
 
    void fixAdditionalProblem() override;
 
 
 
    bool checkDrawMoveContour() const override;
 
 
    void openAdditionalDialog() override;
 
 
    void updateGeometry() override;
 
    Position getPositionInView() const override;
 
    void updateCenteringBoundary(const bool updateGrid) override;
 
    void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList) override;
 
 
 
    std::string getParentName() const override;
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
 
 
    /* @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 override;
 
    /* @brief method for getting the Attribute of an XML key in double format
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getAttributeDouble(SumoXMLAttr key) const override;
 
    /* @brief method for getting the Attribute of an XML key in position format
     * @param[in] key The attribute key
     * @return position with the value associated to key
     */
    Position getAttributePosition(SumoXMLAttr key) const override;
 
    /* @brief method for getting the Attribute of an XML key in positionVector format
     * @param[in] key The attribute key
     * @return positionVector with the value associated to key
     */
    PositionVector getAttributePositionVector(SumoXMLAttr key) const override;
 
    /* @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) override;
 
    /* @brief method for checking if the key and their correspond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value associated to key key
     * @return true if the value is valid, false in other case
     */
    bool isValid(SumoXMLAttr key, const std::string& value) override;
 
    std::string getPopUpID() const override;
 
    std::string getHierarchyName() const override;
 
 
protected:
    double myPositionOverLane = 0;
 
    SUMOTime myFrequency = 0;
 
    std::string myOutput;
 
    double myJamThreshold = 0;
 
    std::vector<std::string> myVTypes;
 
    std::vector<GUIGeometry> myEdgeCalibratorGeometries;
 
    std::vector<GNEContour*>* myEdgeCalibratorContours;
 
private:
    void drawCalibratorSymbol(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                              const double exaggeration, const Position& pos, const double rot,
                              const int symbolIndex) const;
 
    void setAttribute(SumoXMLAttr key, const std::string& value) override;
 
    GNECalibrator(const GNECalibrator&) = delete;
 
    GNECalibrator& operator=(const GNECalibrator&) = delete;
};