GNEDetector.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 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
/****************************************************************************/
// A abstract class to define common parameters of detectors placed over lanes
/****************************************************************************/
#pragma once
#include <config.h>
#include "GNEAdditional.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEDetector : public GNEAdditional, public Parameterised {
 
public:
    GNEDetector(const std::string& id, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, const double pos,
                const SUMOTime period, const std::vector<GNELane*>& parentLanes, const std::string& filename,
                const std::vector<std::string>& vehicleTypes, const std::vector<std::string>& nextEdges, const std::string& detectPersons,
                const std::string& name, const bool friendlyPos, const Parameterised::Map& parameters);
 
    GNEDetector(GNEAdditional* additionalParent, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, const double pos,
                const SUMOTime period, const std::vector<GNELane*>& parentLanes, const std::string& filename, const std::string& name,
                const bool friendlyPos, const Parameterised::Map& parameters);
 
    ~GNEDetector();
 
    GNEMoveOperation* getMoveOperation();
 
 
    virtual void writeAdditional(OutputDevice& device) const = 0;
 
    virtual bool isAdditionalValid() const = 0;
 
    virtual std::string getAdditionalProblem() const = 0;
 
    virtual void fixAdditionalProblem() = 0;
 
 
 
    bool checkDrawMoveContour() const;
 
 
    GNELane* getLane() const;
 
    double getPositionOverLane() const;
 
    double getGeometryPositionOverLane() const;
 
 
    virtual void updateGeometry() = 0;
 
    Position getPositionInView() const;
 
    void updateCenteringBoundary(const bool updateGrid);
 
    void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
 
 
 
    std::string getParentName() const;
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
 
 
    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    virtual std::string getAttribute(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    virtual double getAttributeDouble(SumoXMLAttr key) const = 0;
 
    const Parameterised::Map& getACParametersMap() 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
     */
    virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    /* @brief method for checking if the key and their conrrespond 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
     */
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
 
    std::string getPopUpID() const;
 
    std::string getHierarchyName() const;
 
 
protected:
    double myPositionOverLane = 0;
 
    SUMOTime myPeriod = 0;
 
    std::string myFilename;
 
    std::vector<std::string> myVehicleTypes;
 
    std::vector<std::string> myNextEdges;
 
    std::string myDetectPersons;
 
    bool myFriendlyPosition = false;
 
    /* @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 getDetectorAttribute(SumoXMLAttr key) const;
 
    /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getDetectorAttributeDouble(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 setDetectorAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
 
    /* @brief method for checking if the key and their conrrespond 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 isDetectorValid(SumoXMLAttr key, const std::string& value);
 
    void writeDetectorValues(OutputDevice& device) const;
 
    void setDetectorAttribute(SumoXMLAttr key, const std::string& value);
 
    void drawE1Shape(const GUIVisualizationSettings::Detail d, const double exaggeration,
                     const RGBColor& mainColor, const RGBColor& secondColor) const;
 
    void drawE1DetectorLogo(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                            const double exaggeration, const std::string& logo, const RGBColor& textColor) const;
 
    void drawE2DetectorLogo(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                            const double exaggeration, const std::string& logo, const RGBColor& textColor) const;
 
private:
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    virtual void setMoveShape(const GNEMoveResult& moveResult) = 0;
 
    virtual void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList) = 0;
 
    const Position& getPosition() const = delete;
 
    void setPosition(const Position& pos) = delete;
};