GNEMeanData.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
/****************************************************************************/
// Class for representing MeanData
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNEAttributeCarrier.h>
#include <netedit/elements/GNEHierarchicalElement.h>
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEMeanData : public GNEAttributeCarrier, public GNEHierarchicalElement {
 
public:
    GNEMeanData(SumoXMLTag tag, std::string ID, GNENet* net, FileBucket* fileBucket);
 
    GNEMeanData(SumoXMLTag tag, std::string ID, GNENet* net, FileBucket* fileBucket, const std::string& file,
                const std::string& type, const SUMOTime period, const SUMOTime begin, const SUMOTime end,
                const bool trackVehicles, const std::vector<SumoXMLAttr>& writtenAttributes, const bool aggregate,
                const std::vector<std::string>& edges, const std::string& edgeFile, const std::string& excludeEmpty,
                const bool withInternal, const std::vector<std::string>& detectPersons, const double minSamples,
                const double maxTravelTime, const std::vector<std::string>& vTypes, const double speedThreshold);
 
    ~GNEMeanData();
 
 
    GNEHierarchicalElement* getHierarchicalElement() override;
 
    GNEMoveElement* getMoveElement() const override;
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
    GUIGlObject* getGUIGlObject() override;
 
    const GUIGlObject* getGUIGlObject() const override;
 
 
    FileBucket* getFileBucket() const override;
 
    void writeMeanData(OutputDevice& device) const;
 
    void updateGeometry() override;
 
    Position getPositionInView() const;
 
 
    bool checkDrawFromContour() const override;
 
    bool checkDrawToContour() const override;
 
    bool checkDrawRelatedContour() const override;
 
    bool checkDrawOverContour() const override;
 
    bool checkDrawDeleteContour() const override;
 
    bool checkDrawDeleteContourSmall() const override;
 
    bool checkDrawSelectContour() const override;
 
    bool checkDrawMoveContour() 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 (to avoid unnecessary parse<double>(...) for certain attributes)
     * @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;
 
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) override;
 
    bool isValid(SumoXMLAttr key, const std::string& value) override;
 
    std::string getPopUpID() const override;
 
    std::string getHierarchyName() const override;
 
protected:
    std::string myID;
 
    std::string myFile;
 
    std::string myType;
 
    SUMOTime myPeriod = 0;
 
    SUMOTime myBegin = 0;
 
    SUMOTime myEnd = 0;
 
    bool myTrackVehicles = false;
 
    std::vector<SumoXMLAttr> myWrittenAttributes;
 
    bool myAggregate = false;
 
    std::vector<std::string> myEdges;
 
    std::string myEdgeFile;
 
    std::string myExcludeEmpty;
 
    bool myWithInternal = false;
 
    std::vector<std::string> myDetectPersons;
 
    double myMinSamples = 0;
 
    double myMaxTravelTime = 0;
 
    std::vector<std::string> myVTypes;
 
    double mySpeedThreshold = 0;
 
private:
    void setAttribute(SumoXMLAttr key, const std::string& value) override;
 
    GNEMeanData(const GNEMeanData&) = delete;
 
    GNEMeanData& operator=(const GNEMeanData&) = delete;
};
 
/****************************************************************************/