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 : int {
        // basic types
        NETWORKELEMENT =    1 << 0,  // Network elements (Edges, Junctions, Lanes...)
        ADDITIONALELEMENT = 1 << 1,  // Additional elements (Bus Stops, Charging Stations, Detectors...)
        DEMANDELEMENT =     1 << 2,  // Demand elements (Routes, Vehicles, Trips...)
        DATAELEMENT =       1 << 3,  // Data elements (DataSets, Data Intervals, EdgeData...)
        // sub additional elements
        STOPPINGPLACE =     1 << 4,  // StoppingPlaces (BusStops, ChargingStations...)
        DETECTOR =          1 << 5,  // Detectors (E1, E2...)
        CALIBRATOR =        1 << 6,  // Calibrators
        SHAPE =             1 << 7,  // Shapes (Polygons and POIs)
        TAZELEMENT =        1 << 8,  // Traffic Assignment Zones
        WIRE =              1 << 9,  // Wire elements
        JUPEDSIM =          1 << 10, // JuPedSim elements
        // sub demand elements
        VTYPE =             1 << 11, // Vehicle types (vType and vTypeDistribution)
        VEHICLE =           1 << 12, // Vehicles (Vehicles, trips, flows...)
        ROUTE =             1 << 13, // Routes and embedded routes
        STOP_VEHICLE =      1 << 14, // Vehicle stops
        WAYPOINT_VEHICLE =  1 << 15, // Vehicle waypoints (note: All waypoints are also Stops)
        FLOW =              1 << 16, // Flows
        // persons
        PERSON =            1 << 17, // Persons (Persons and personFlows)
        PERSONPLAN =        1 << 18, // Person plans (Walks, rides, personTrips and stopPersons)
        PERSONTRIP =        1 << 19, // Person Trips
        WALK =              1 << 20, // Walks
        RIDE =              1 << 21, // Rides
        STOP_PERSON =       1 << 22, // Person stops
        // containers
        CONTAINER =         1 << 23, // Containers (Containers and personFlows)
        CONTAINERPLAN =     1 << 24, // Container plans (transport, tranships and containerStops)
        TRANSPORT =         1 << 25, // Transport
        TRANSHIP =          1 << 26, // Tranship
        STOP_CONTAINER =    1 << 27, // Container stops
        // sub data elements
        GENERICDATA =       1 << 28, // Generic data (GNEEdgeData, GNELaneData...)
        MEANDATA =          1 << 29, // Mean datas
        // other
        INTERNALLANE =      1 << 30, // Internal Lane
        OTHER =             1 << 31, // Other type (used for TAZSourceSinks, VTypes, etc.)
    };
 
    enum class Property : int {
        NOTDRAWABLE =           1 << 0,     // Element cannot be drawn in view
        GEOSHAPE =              1 << 1,     // Element's shape acn be defined using a GEO Shape
        DIALOG =                1 << 2,     // Element can be edited using a dialog (GNECalibratorDialog, GNERerouterDialog...)
        XMLCHILD =              1 << 3,     // Element is child of another element and will be written in XML (Example: E3Entry -> E3Detector...)
        REPARENT =              1 << 4,     // Element can be reparent
        NOTSELECTABLE =         1 << 5,     // Element cannot be selected
        NOPARAMETERS =          1 << 6,     // Element doesn't accept parameters "key1=value1|key2=value2|...|keyN=valueN" (by default all tags supports parameters)
        RTREE =                 1 << 7,     // Element is placed in RTREE
        CENTERAFTERCREATION =   1 << 8,     // Camera is moved after element creation
        REQUIRE_PROJ =          1 << 9,     // Element require a geo-projection defined in network
        VCLASS_ICON =           1 << 10,    // Element returns icon depending of their vClass
        SYMBOL =                1 << 11,    // Element is a symbol (VSSSymbols, RerouterSymbols...)
        EXTENDED =              1 << 12,    // Element contains extended attributes (Usually vTypes)
        HIERARCHICAL =          1 << 13,    // Element is a hierarchical
        NO_PROPERTY =           1 << 14,    // Element doesn't have properties
    };
 
    enum class Over : int {
        VIEW =                  1 << 0,     // No parents
        JUNCTION =              1 << 1,     // Placed over junction
        EDGE =                  1 << 2,     // Placed over edge
        EDGES =                 1 << 3,     // Placed over edges
        CONSECUTIVE_EDGES =     1 << 4,     // Placed over consecutive
        LANE =                  1 << 5,     // Placed over lane
        LANES =                 1 << 6,     // Placed over lanes
        CONSECUTIVE_LANES =     1 << 4,     // Placed over consecutive lanes
        ROUTE =                 1 << 7,     // Placed over route
        ROUTE_EMBEDDED =        1 << 8,     // Placed over route embedded
        BUSSTOP =               1 << 9,     // Placed over busStop
        TRAINSTOP =             1 << 10,    // Placed over trainStop
        CONTAINERSTOP =         1 << 11,    // Placed over containerStop
        CHARGINGSTATION =       1 << 12,    // Placed over charging station
        PARKINGAREA =           1 << 13,    // Placed over parking area
        FROM_EDGE =             1 << 14,    // Starts in edge
        FROM_TAZ =              1 << 15,    // Starts in TAZ
        FROM_JUNCTION =         1 << 16,    // Starts in junction
        FROM_BUSSTOP =          1 << 17,    // Starts in busStop
        FROM_TRAINSTOP =        1 << 18,    // Starts in trainStop
        FROM_CONTAINERSTOP =    1 << 19,    // Starts in containerStop
        FROM_CHARGINGSTATION =  1 << 20,    // Starts in chargingStation
        FROM_PARKINGAREA =      1 << 21,    // Starts in parkingArea
        TO_EDGE =               1 << 22,    // Ends in edge
        TO_TAZ =                1 << 23,    // Ends in TAZ
        TO_JUNCTION =           1 << 24,    // Ends in junction
        TO_BUSSTOP =            1 << 25,    // Ends in busStop
        TO_TRAINSTOP =          1 << 26,    // Ends in trainStop
        TO_CONTAINERSTOP =      1 << 27,    // Ends in containerStop
        TO_CHARGINGSTATION =    1 << 28,    // Ends in chargingStation
        TO_PARKINGAREA =        1 << 29,    // Ends in parkingArea
    };
 
    // @brief conflicts
    enum class Conflicts : int {
        POS_LANE =                  1 << 0,     // Position over lane isn't valid
        POS_LANE_START =            1 << 1,     // Start position over lane isn't valid
        POS_LANE_END =              1 << 2,     // End position over lane isn't valid
        NO_ADDITIONAL_CHILDREN =    1 << 3,     // Element doesn't have additional children
        NO_CONFLICTS =              1 << 4,     // Element doesn't have conflicts
    };
 
    friend class GNEAttributeProperties;
 
    GNETagProperties(const SumoXMLTag tag, GNETagProperties* parent, const Type tagType, const Property tagProperty, const Over tagOver,
                     const Conflicts conflicts, const GUIIcon icon, const GUIGlObjectType GLType, const SumoXMLTag XMLTag,
                     const std::string tooltip, 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 isTypeDist() 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 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 canCenterCameraAfterCreation() const;
 
    bool requireProj() const;
 
    bool vClassIcon() 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 myTagType = Type::OTHER;
 
    const Property myTagProperty = Property::NO_PROPERTY;
 
    const Over myTagOver = Over::VIEW;
 
    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<int>(a) | static_cast<int>(b));
}
 
constexpr bool operator&(GNETagProperties::Type a, GNETagProperties::Type b) {
    return (static_cast<int>(a) & static_cast<int>(b)) != 0;
}
 
constexpr GNETagProperties::Property operator|(GNETagProperties::Property a, GNETagProperties::Property b) {
    return static_cast<GNETagProperties::Property>(static_cast<int>(a) | static_cast<int>(b));
}
 
constexpr bool operator&(GNETagProperties::Property a, GNETagProperties::Property b) {
    return (static_cast<int>(a) & static_cast<int>(b)) != 0;
}
 
constexpr GNETagProperties::Over operator|(GNETagProperties::Over a, GNETagProperties::Over b) {
    return static_cast<GNETagProperties::Over>(static_cast<int>(a) | static_cast<int>(b));
}
 
constexpr bool operator&(GNETagProperties::Over a, GNETagProperties::Over b) {
    return (static_cast<int>(a) & static_cast<int>(b)) != 0;
}
 
constexpr GNETagProperties::Conflicts operator|(GNETagProperties::Conflicts a, GNETagProperties::Conflicts b) {
    return static_cast<GNETagProperties::Conflicts>(static_cast<int>(a) | static_cast<int>(b));
}
 
constexpr bool operator&(GNETagProperties::Conflicts a, GNETagProperties::Conflicts b) {
    return (static_cast<int>(a) & static_cast<int>(b)) != 0;
}
 
/****************************************************************************/