GNEDetector.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
/****************************************************************************/
// 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(GNENet* net, SumoXMLTag tag);
 
    GNEDetector(const std::string& id, GNENet* net, const std::string& filename, SumoXMLTag tag,
                const SUMOTime period, const std::string& outputFilename, const std::vector<std::string>& vehicleTypes,
                const std::vector<std::string>& nextEdges, const std::string& detectPersons, const std::string& name,
                const Parameterised::Map& parameters);
 
    GNEDetector(GNEAdditional* additionalParent, SumoXMLTag tag, const SUMOTime period, const std::string& outputFilename,
                const std::string& name, const Parameterised::Map& parameters);
 
    ~GNEDetector();
 
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
 
 
    bool checkDrawMoveContour() const 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;
 
 
 
    /* @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;
 
    std::string getPopUpID() const override;
 
    std::string getHierarchyName() const override;
 
 
protected:
    SUMOTime myPeriod = 0;
 
    std::string myOutputFilename;
 
    std::vector<std::string> myVehicleTypes;
 
    std::vector<std::string> myNextEdges;
 
    std::string myDetectPersons;
 
    /* @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
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getDetectorAttributeDouble(SumoXMLAttr key) const;
 
    /* @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 getDetectorAttributePosition(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:
    const Position& getPosition() const = delete;
 
    void setPosition(const Position& pos) = delete;
};