GNETagProperties.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
/****************************************************************************/
// Abstract Base class for tag properties used in GNEAttributeCarrier
/****************************************************************************/
#pragma once
#include <config.h>
 
 
// ===========================================================================
// included modules
// ===========================================================================
 
#include <utils/gui/images/GUIIcons.h>
#include <netedit/GNEViewNetHelper.h>
 
#include "GNEAttributeProperties.h"
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNETagProperties {
 
public:
 
    enum TagType {
        // 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
        VEHICLESTOP =       1 << 14, // Vehicle stops
        VEHICLEWAYPOINT =   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
        STOPPERSON =        1 << 22, // Person stops
        // containers
        CONTAINER =         1 << 23, // Containers (Containers and personFlows)
        CONTAINERPLAN =     1 << 24, // Container plans (tranship and transport)
        TRANSPORT =         1 << 25, // Transport
        TRANSHIP =          1 << 26, // Tranship
        STOPCONTAINER =     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
    };
 
    enum TagProperty {
        NO_PROPERTY =           1 << 0,     // Element doesn't have properties
        NOTDRAWABLE =           1 << 1,     // Element cannot be drawn in view
        CLOSESHAPE =            1 << 2,     // Element can close their shape
        GEOSHAPE =              1 << 3,     // Element's shape acn be defined using a GEO Shape
        DIALOG =                1 << 4,     // Element can be edited using a dialog (GNECalibratorDialog, GNERerouterDialog...)
        CHILD =                 1 << 5,     // Element is child of another element and will be written in XML without id (Example: E3Entry -> E3Detector...)
        REPARENT =              1 << 6,     // Element can be reparent
        NOTSELECTABLE =         1 << 7,     // Element cannot be selected
        MASKSTARTENDPOS =       1 << 8,     // Element mask attributes StartPos and EndPos as "length" (Only used in the appropiate GNEFrame)
        NOPARAMETERS =          1 << 9,     // Element doesn't accept parameters "key1=value1|key2=value2|...|keyN=valueN" (by default all tags supports parameters)
        RTREE =                 1 << 10,     // Element is placed in RTREE
        CENTERAFTERCREATION =   1 << 11,    // Camera is moved after element creation
        REQUIRE_PROJ =          1 << 12,    // Element require a geo-projection defined in network
        VCLASS_ICON =           1 << 13,    // Element returns icon depending of their vClass
        SYMBOL =                1 << 14,    // Symbol elements (VSSSymbols, RerouterSymbols...)
    };
 
    enum TagParents {
        NO_PARENTS =                1 << 0,     // No parents
        // exclusive of vehicles
        VEHICLE_ROUTE =             1 << 1,     // Vehicle is placed over route
        VEHICLE_ROUTE_EMBEDDED =    1 << 2,     // Vehicle has an embedded route
        VEHICLE_EDGES =             1 << 3,     // Vehicle is placed over a from-to edges
        VEHICLE_JUNCTIONS =         1 << 4,     // Vehicle is placed over a from-to junctions
        VEHICLE_TAZS =              1 << 5,     // Vehicle is placed over a from-to TAZs
        // exclusive of plans
        PLAN_CONSECUTIVE_EDGES =    1 << 6,     // Plan placed in consecutive edges
        PLAN_ROUTE =                1 << 7,     // Plan placed in route
        PLAN_EDGE =                 1 << 8,     // Plan placed in edge
        PLAN_BUSSTOP =              1 << 9,     // Plan placed in busStop
        PLAN_TRAINSTOP =            1 << 10,    // Plan placed in trainStop
        PLAN_CONTAINERSTOP =        1 << 11,    // Plan placed in containerStop
        PLAN_FROM_EDGE =            1 << 12,    // Plan starts in edge
        PLAN_FROM_TAZ =             1 << 13,    // Plan starts in TAZ
        PLAN_FROM_JUNCTION =        1 << 14,    // Plan starts in junction
        PLAN_FROM_BUSSTOP =         1 << 15,    // Plan starts in busStop
        PLAN_FROM_TRAINSTOP =       1 << 16,    // Plan starts in trainStop
        PLAN_FROM_CONTAINERSTOP =   1 << 17,    // Plan starts in containerStop
        PLAN_TO_EDGE =              1 << 18,    // Plan ends in edge
        PLAN_TO_TAZ =               1 << 19,    // Plan ends in TAZ
        PLAN_TO_JUNCTION =          1 << 20,    // Plan ends in junction
        PLAN_TO_BUSSTOP =           1 << 21,    // Plan ends in busStop
        PLAN_TO_TRAINSTOP =         1 << 22,    // Plan ends in trainStop
        PLAN_TO_CONTAINERSTOP =     1 << 23,    // Plan ends in containerStop
    };
 
    // @brief conflicts
    enum Conflicts {
        NO_CONFLICTS =              1 << 0,     // Element doesn't have conflicts
        POS_LANE =                  1 << 1,     // Position over lane isn't valid
        POS_LANE_START =            1 << 2,     // Start position over lane isn't valid
        POS_LANE_END =              1 << 3,     // End position over lane isn't valid
        NO_ADDITIONAL_CHILDREN =    1 << 4,     // Element doesn't have additional children
    };
 
    GNETagProperties();
 
    GNETagProperties(const SumoXMLTag tag, const int tagType, const int tagProperty, const int tagParents, const int conflicts,
                     const GUIIcon icon, const SumoXMLTag XMLTag, const std::string tooltip, std::vector<SumoXMLTag> parentTags = {},
                     const unsigned int backgroundColor = FXRGBA(255, 255, 255, 255), const std::string fieldString = "");
 
    ~GNETagProperties();
 
    SumoXMLTag getTag() const;
 
    Supermode getSupermode() const;
 
    const std::string& getTagStr() const;
 
    void checkTagIntegrity() const;
 
    void addAttribute(const GNEAttributeProperties& attributeProperty);
 
    const std::string& getFieldString() const;
 
    const std::string& getTooltipText() const;
 
    unsigned int getBackGroundColor() const;
 
    const GNEAttributeProperties& getAttributeProperties(SumoXMLAttr attr) const;
 
    std::vector<GNEAttributeProperties>::const_iterator begin() const;
 
    std::vector<GNEAttributeProperties>::const_iterator end() const;
 
    const GNEAttributeProperties& at(int index) const;
 
    int getNumberOfAttributes() const;
 
    const std::string& getDefaultValue(SumoXMLAttr attr) const;
 
    GUIIcon getGUIIcon() const;
 
    SumoXMLTag getXMLTag() const;
 
    const std::vector<SumoXMLTag>& getParentTags() const;
 
    bool hasAttribute(SumoXMLAttr attr) const;
 
 
    bool isNetworkElement() const;
 
    bool isAdditionalElement() const;
 
    bool isAdditionalPureElement() const;
 
    bool isDemandElement() const;
 
    bool isDataElement() 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 isPlan() const;
 
    bool isPlanPerson() const;
 
    bool isPlanContainer() const;
 
    bool isPersonTrip() 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 planStoppingPlace() const;
 
    bool planFromTo() const;
 
    bool planFromEdge() const;
 
    bool planFromTAZ() const;
 
    bool planFromJunction() const;
 
    bool planFromStoppingPlace() const;
 
    bool planFromBusStop() const;
 
    bool planFromTrainStop() const;
 
    bool planFromContainerStop() const;
 
    bool planToEdge() const;
 
    bool planToTAZ() const;
 
    bool planToJunction() const;
 
    bool planToStoppingPlace() const;
 
    bool planToBusStop() const;
 
    bool planToTrainStop() const;
 
    bool planToContainerStop() const;
 
 
    bool isChild() const;
 
    bool isSymbol() const;
 
    bool isInternalLane() const;
 
    bool isDrawable() const;
 
    bool isSelectable() const;
 
    bool canCloseShape() const;
 
    bool hasGEOShape() const;
 
    bool hasDialog() const;
 
    bool hasParameters() const;
 
    bool isPlacedInRTree() const;
 
    bool canBeReparent() const;
 
    bool canMaskStartEndPos() const;
 
    bool canCenterCameraAfterCreation() const;
 
    bool requireProj() const;
 
    bool vClassIcon() const;
 
private:
    SumoXMLTag myTag = SUMO_TAG_NOTHING;
 
    std::string myTagStr;
 
    int myTagType = -1;
 
    int myTagProperty = -1;
 
    int myTagParents = -1;
 
    int myConflicts = -1;
 
    std::vector<GNEAttributeProperties> myAttributeProperties;
 
    GUIIcon myIcon = GUIIcon::EMPTY;
 
    SumoXMLTag myXMLTag = SUMO_TAG_NOTHING;
 
    std::string myTooltipText;
 
    std::vector<SumoXMLTag> myParentTags;
 
    std::string myFieldString;
 
    unsigned int myBackgroundColor = 0;
};
 
/****************************************************************************/