GNETagProperties.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
/****************************************************************************/
// Abstract Base class for tag properties used in GNEAttributeCarrier
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/gui/globjects/GUIGlObjectTypes.h>
#include <utils/gui/images/GUIIcons.h>
#include <netedit/GNEViewNetHelper.h>
#include "GNEAttributeProperties.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNETagProperties {
 
public:

    enum class Type : std::uint64_t {
        // basic types
        NETWORKELEMENT =    1ULL << 0,  // Network elements (Edges, Junctions, Lanes...)
        ADDITIONALELEMENT = 1ULL << 1,  // Additional elements (Bus Stops, Charging Stations, Detectors...)
        DEMANDELEMENT =     1ULL << 2,  // Demand elements (Routes, Vehicles, Trips...)
        DATAELEMENT =       1ULL << 3,  // Data elements (DataSets, Data Intervals, EdgeData...)
        // sub additional elements
        STOPPINGPLACE =     1ULL << 4,  // StoppingPlaces (BusStops, ChargingStations...)
        DETECTOR =          1ULL << 5,  // Detectors (E1, E2...)
        CALIBRATOR =        1ULL << 6,  // Calibrators
        SHAPE =             1ULL << 7,  // Shapes (Polygons and POIs)
        TAZELEMENT =        1ULL << 8,  // Traffic Assignment Zones
        WIRE =              1ULL << 9,  // Wire elements
        JUPEDSIM =          1ULL << 10, // JuPedSim elements
        // sub demand elements
        VTYPE =             1ULL << 11, // Vehicle types (vType and vTypeDistribution)
        VEHICLE =           1ULL << 12, // Vehicles (Vehicles, trips, flows...)
        ROUTE =             1ULL << 13, // Routes and embedded routes
        STOP_VEHICLE =      1ULL << 14, // Vehicle stops
        WAYPOINT_VEHICLE =  1ULL << 15, // Vehicle waypoints (note: All waypoints are also Stops)
        FLOW =              1ULL << 16, // Flows
        // persons
        PERSON =            1ULL << 17, // Persons (Persons and personFlows)
        PERSONPLAN =        1ULL << 18, // Person plans (Walks, rides, personTrips and stopPersons)
        PERSONTRIP =        1ULL << 19, // Person Trips
        WALK =              1ULL << 20, // Walks
        RIDE =              1ULL << 21, // Rides
        STOP_PERSON =       1ULL << 22, // Person stops
        // containers
        CONTAINER =         1ULL << 23, // Containers (Containers and personFlows)
        CONTAINERPLAN =     1ULL << 24, // Container plans (transport, tranships and containerStops)
        TRANSPORT =         1ULL << 25, // Transport
        TRANSHIP =          1ULL << 26, // Tranship
        STOP_CONTAINER =    1ULL << 27, // Container stops
        // sub data elements
        GENERICDATA =       1ULL << 28, // Generic data (GNEEdgeData, GNELaneData...)
        MEANDATA =          1ULL << 29, // Mean datas
        // distributions
        DISTRIBUTION =      1ULL << 30, // Element is a distribution (routeDistribution or vTypeDistribution)
        DISTRIBUTIONREF =   1ULL << 31, // Element is a distribution reference of routeDistribution or vTypeDistribution
        // other
        INTERNALLANE =      1ULL << 32, // Internal Lane
        OTHER =             1ULL << 33, // Other type (used for TAZSourceSinks, VTypes, etc.)
    };

    enum class Property : std::uint64_t {
        NOTDRAWABLE =           1ULL << 0,  // Element cannot be drawn in view
        GEOSHAPE =              1ULL << 1,  // Element's shape acn be defined using a GEO Shape
        DIALOG =                1ULL << 2,  // Element can be edited using a dialog (GNECalibratorDialog, GNERerouterDialog...)
        XMLCHILD =              1ULL << 3,  // Element is child of another element and will be written in XML (Example: E3Entry -> E3Detector...)
        REPARENT =              1ULL << 4,  // Element can be reparent
        NOTSELECTABLE =         1ULL << 5,  // Element cannot be selected
        NOPARAMETERS =          1ULL << 6,  // Element doesn't accept parameters "key1=value1|key2=value2|...|keyN=valueN" (by default all tags supports parameters)
        RTREE =                 1ULL << 7,  // Element is placed in RTREE
        CENTERAFTERCREATION =   1ULL << 8,  // Camera is moved after element creation
        REQUIRE_PROJ =          1ULL << 9,  // Element require a geo-projection defined in network
        VCLASS_ICON =           1ULL << 10, // Element returns icon depending of their vClass
        SYMBOL =                1ULL << 11, // Element is a symbol (VSSSymbols, RerouterSymbols...)
        EXTENDED =              1ULL << 12, // Element contains extended attributes (Usually vTypes)
        HIERARCHICAL =          1ULL << 13, // Element is a hierarchical
        LISTED =                1ULL << 14, // Element is a listed elements (for example, rerouter children)
        NO_PROPERTY =           1ULL << 15, // Element doesn't have properties
    };

    enum class Over : std::uint64_t {
        VIEW =                  1ULL << 0,  // No parents
        JUNCTION =              1ULL << 1,  // Placed over junction
        EDGE =                  1ULL << 2,  // Placed over edge
        EDGES =                 1ULL << 3,  // Placed over edges
        CONSECUTIVE_EDGES =     1ULL << 4,  // Placed over consecutive
        LANE =                  1ULL << 5,  // Placed over lane
        LANES =                 1ULL << 6,  // Placed over lanes
        CONSECUTIVE_LANES =     1ULL << 4,  // Placed over consecutive lanes
        ROUTE =                 1ULL << 7,  // Placed over route
        ROUTE_EMBEDDED =        1ULL << 8,  // Placed over route embedded
        BUSSTOP =               1ULL << 9, // Placed over busStop
        TRAINSTOP =             1ULL << 10, // Placed over trainStop
        CONTAINERSTOP =         1ULL << 11, // Placed over containerStop
        CHARGINGSTATION =       1ULL << 12, // Placed over charging station
        PARKINGAREA =           1ULL << 13, // Placed over parking area
        FROM_EDGE =             1ULL << 14, // Starts in edge
        FROM_TAZ =              1ULL << 15, // Starts in TAZ
        FROM_JUNCTION =         1ULL << 16, // Starts in junction
        FROM_BUSSTOP =          1ULL << 17, // Starts in busStop
        FROM_TRAINSTOP =        1ULL << 18, // Starts in trainStop
        FROM_CONTAINERSTOP =    1ULL << 19, // Starts in containerStop
        FROM_CHARGINGSTATION =  1ULL << 20, // Starts in chargingStation
        FROM_PARKINGAREA =      1ULL << 21, // Starts in parkingArea
        TO_EDGE =               1ULL << 22, // Ends in edge
        TO_TAZ =                1ULL << 23, // Ends in TAZ
        TO_JUNCTION =           1ULL << 24, // Ends in junction
        TO_BUSSTOP =            1ULL << 25, // Ends in busStop
        TO_TRAINSTOP =          1ULL << 26, // Ends in trainStop
        TO_CONTAINERSTOP =      1ULL << 27, // Ends in containerStop
        TO_CHARGINGSTATION =    1ULL << 28, // Ends in chargingStation
        TO_PARKINGAREA =        1ULL << 29, // Ends in parkingArea
    };

    enum class File : std::uint64_t {
        NETWORK =       1ULL << 0,    // Element can be saved in a network file
        ADDITIONAL =    1ULL << 1,    // Element can be saved in a additional file
        DEMAND =        1ULL << 2,    // Element can be saved in a demand file
        DATA =          1ULL << 3,    // Element can be saved in a data file
        MEANDATA =      1ULL << 4,    // Element can be saved in a meanData file
        JUNCTION =      1ULL << 5,    // Element can be saved in a joined junction file
        TYPE =          1ULL << 6,    // Element can be saved in a edge type file
        TLS =           1ULL << 7,    // Element can be saved in a TLS file
    };
 
    // @brief conflicts
    enum class Conflicts : std::uint64_t {
        POS_LANE =                  1ULL << 0,  // Position over lane isn't valid
        POS_LANE_START =            1ULL << 1,  // Start position over lane isn't valid
        POS_LANE_END =              1ULL << 2,  // End position over lane isn't valid
        NO_ADDITIONAL_CHILDREN =    1ULL << 3,  // Element doesn't have additional children
        NO_CONFLICTS =              1ULL << 4,  // Element doesn't have conflicts
    };

    friend class GNEAttributeProperties;

    GNETagProperties(const SumoXMLTag tag, GNETagProperties* parent, const Type type, const Property property, const Over over,
                     const File file, const Conflicts conflicts, const GUIIcon icon, const GUIGlObjectType GLType, const SumoXMLTag XMLTag,
                     const std::string tooltipText, std::vector<SumoXMLTag> XMLParentTags = {},
                     const unsigned int backgroundColor = FXRGBA(255, 255, 255, 255), const std::string selectorText = "");

    GNETagProperties(const SumoXMLTag tag, GNETagProperties* parent, const GUIIcon icon, const std::string tooltip,
                     const unsigned int backgroundColor = FXRGBA(255, 255, 255, 255), const std::string selectorText = "");

    ~GNETagProperties();

    SumoXMLTag getTag() const;

    const std::string& getTagStr() const;

    void checkTagIntegrity() const;

    const std::string& getSelectorText() const;

    const std::string& getTooltipText() const;

    unsigned int getBackGroundColor() const;

    const std::vector<const GNEAttributeProperties*>& getAttributeProperties() const;

    const GNEAttributeProperties* getAttributeProperties(SumoXMLAttr attr) const;

    const GNEAttributeProperties* getAttributeProperties(const int index) const;

    const GNEAttributeProperties* at(int index) const;

    bool hasAttribute(SumoXMLAttr attr) const;

    int getNumberOfAttributes() const;

    GUIIcon getGUIIcon() const;

    GUIGlObjectType getGLType() const;


    SumoXMLTag getXMLTag() const;

    const std::vector<SumoXMLTag>& getXMLParentTags() const;

    bool canBeReparent() const;


    const std::string& getDefaultStringValue(SumoXMLAttr attr) const;

    int getDefaultIntValue(SumoXMLAttr attr) const;

    double getDefaultDoubleValue(SumoXMLAttr attr) const;

    SUMOTime getDefaultTimeValue(SumoXMLAttr attr) const;

    bool getDefaultBoolValue(SumoXMLAttr attr) const;

    const RGBColor& getDefaultColorValue(SumoXMLAttr attr) const;



    const GNETagProperties* getHierarchicalParent() const;

    const std::vector<const GNETagProperties*> getHierarchicalParentsRecuersively() const;

    const std::vector<const GNETagProperties*>& getHierarchicalChildren() const;

    std::vector<const GNETagProperties*> getHierarchicalChildrenRecursively() const;

    std::map<std::string, const GNEAttributeProperties*> getHierarchicalChildrenAttributesRecursively(const bool onlyCommon, const bool onlyDrawables) const;


    Supermode getSupermode() const;

    bool isHierarchicalTag() const;


    bool isNetworkElement() const;

    bool isAdditionalElement() const;

    bool isAdditionalPureElement() const;

    bool isDemandElement() const;

    bool isDataElement() const;

    bool isOtherElement() const;


    bool isStoppingPlace() const;

    bool isDetector() const;

    bool isCalibrator() const;

    bool isShapeElement() const;

    bool isTAZElement() const;

    bool isWireElement() const;

    bool isJuPedSimElement() const;


    bool isType() const;

    bool isVehicle() const;

    bool isRoute() const;

    bool isVehicleStop() const;

    bool isVehicleWaypoint() const;

    bool isFlow() const;

    bool isPerson() const;

    bool isContainer() const;

    bool hasTypeParent() const;

    bool isDistribution() const;

    bool isDistributionReference() const;

    bool isTypeDistribution() const;

    bool isRouteDistribution() const;


    bool isPlan() const;

    bool isPlanPerson() const;

    bool isPlanContainer() const;

    bool isPlanPersonTrip() const;

    bool isPlanWalk() const;

    bool isPlanRide() const;

    bool isPlanTransport() const;

    bool isPlanTranship() const;

    bool isPlanStop() const;

    bool isPlanStopPerson() const;

    bool isPlanStopContainer() const;


    bool isGenericData() const;

    bool isMeanData() const;



    bool vehicleRoute() const;

    bool vehicleRouteEmbedded() const;

    bool vehicleEdges() const;

    bool vehicleJunctions() const;

    bool vehicleTAZs() const;


    bool planConsecutiveEdges() const;

    bool planRoute() const;

    bool planEdge() const;

    bool planBusStop() const;

    bool planTrainStop() const;

    bool planContainerStop() const;

    bool planChargingStation() const;

    bool planParkingArea() const;

    bool planStoppingPlace() const;

    bool planFromTo() const;

    bool planFromEdge() const;

    bool planFromTAZ() const;

    bool planFromJunction() const;

    bool planFromBusStop() const;

    bool planFromTrainStop() const;

    bool planFromContainerStop() const;

    bool planFromChargingStation() const;

    bool planFromParkingArea() const;

    bool planFromStoppingPlace() const;

    bool planToEdge() const;

    bool planToTAZ() const;

    bool planToJunction() const;

    bool planToBusStop() const;

    bool planToTrainStop() const;

    bool planToContainerStop() const;

    bool planToChargingStation() const;

    bool planToParkingArea() const;

    bool planToStoppingPlace() const;


    bool isChild() const;

    bool isSymbol() const;

    bool isInternalLane() const;

    bool isDrawable() const;

    bool isSelectable() const;

    bool hasGEOShape() const;

    bool hasDialog() const;

    bool hasExtendedAttributes() const;

    bool hasParameters() const;

    bool isPlacedInRTree() const;

    bool isListedElement() const;

    bool canCenterCameraAfterCreation() const;

    bool requireProj() const;

    bool vClassIcon() const;


    bool saveInNetworkFile() const;

    bool saveInAdditionalFile() const;

    bool saveInDemandFile() const;

    bool saveInDataFile() const;

    bool saveInMeanDataFile() const;

    bool saveInJunctionFile() const;

    bool saveInEdgeTypeFile() const;

    bool saveInTLSFile() const;

 
protected:
    void addChild(const GNETagProperties* child);
 
private:
    const SumoXMLTag myTag = SUMO_TAG_NOTHING;

    const std::string myTagStr;

    const GNETagProperties* myParent = nullptr;

    std::vector<const GNETagProperties*> myChildren;

    const Type myType = Type::OTHER;

    const Property myProperty = Property::NO_PROPERTY;

    const Over myOver = Over::VIEW;

    const File myFile = File::NETWORK;

    const Conflicts myConflicts = Conflicts::NO_CONFLICTS;

    std::vector<const GNEAttributeProperties*> myAttributeProperties;

    const GUIIcon myIcon = GUIIcon::EMPTY;

    const GUIGlObjectType myGLType = GUIGlObjectType::GLO_MAX;

    const SumoXMLTag myXMLTag = SUMO_TAG_NOTHING;

    const std::string myTooltipText;

    const std::vector<SumoXMLTag> myXMLParentTags;

    const std::string mySelectorText;

    const unsigned int myBackgroundColor = 0;

    void getChildrenTagProperties(const GNETagProperties* tagProperties, std::vector<const GNETagProperties*>& result) const;

    void getChildrenAttributes(const GNETagProperties* tagProperties, std::map<std::string, const GNEAttributeProperties*>& result, const bool onlyDrawables) const;

    GNETagProperties() = delete;

    GNETagProperties(const GNETagProperties&) = delete;

    GNETagProperties& operator=(const GNETagProperties& src) = delete;
};

constexpr GNETagProperties::Type operator|(GNETagProperties::Type a, GNETagProperties::Type b) {
    return static_cast<GNETagProperties::Type>(static_cast<std::uint64_t>(a) | static_cast<std::uint64_t>(b));
}

constexpr bool operator&(GNETagProperties::Type a, GNETagProperties::Type b) {
    return (static_cast<std::uint64_t>(a) & static_cast<std::uint64_t>(b)) != 0;
}

constexpr GNETagProperties::Property operator|(GNETagProperties::Property a, GNETagProperties::Property b) {
    return static_cast<GNETagProperties::Property>(static_cast<std::uint64_t>(a) | static_cast<std::uint64_t>(b));
}

constexpr bool operator&(GNETagProperties::Property a, GNETagProperties::Property b) {
    return (static_cast<std::uint64_t>(a) & static_cast<std::uint64_t>(b)) != 0;
}

constexpr GNETagProperties::Over operator|(GNETagProperties::Over a, GNETagProperties::Over b) {
    return static_cast<GNETagProperties::Over>(static_cast<std::uint64_t>(a) | static_cast<std::uint64_t>(b));
}

constexpr bool operator&(GNETagProperties::Over a, GNETagProperties::Over b) {
    return (static_cast<std::uint64_t>(a) & static_cast<std::uint64_t>(b)) != 0;
}

constexpr GNETagProperties::File operator|(GNETagProperties::File a, GNETagProperties::File b) {
    return static_cast<GNETagProperties::File>(static_cast<std::uint64_t>(a) | static_cast<std::uint64_t>(b));
}

constexpr bool operator&(GNETagProperties::File a, GNETagProperties::File b) {
    return (static_cast<std::uint64_t>(a) & static_cast<std::uint64_t>(b)) != 0;
}

constexpr GNETagProperties::Conflicts operator|(GNETagProperties::Conflicts a, GNETagProperties::Conflicts b) {
    return static_cast<GNETagProperties::Conflicts>(static_cast<std::uint64_t>(a) | static_cast<std::uint64_t>(b));
}

constexpr bool operator&(GNETagProperties::Conflicts a, GNETagProperties::Conflicts b) {
    return (static_cast<std::uint64_t>(a) & static_cast<std::uint64_t>(b)) != 0;
}
 
/****************************************************************************/