AdditionalHandler.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
/****************************************************************************/
// The XML-Handler for additionals loading
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/xml/CommonXMLStructure.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class AdditionalHandler {
 
public:
    AdditionalHandler();
 
    virtual ~AdditionalHandler();
 
    bool beginParseAttributes(SumoXMLTag tag, const SUMOSAXAttributes& attrs);
 
    void endParseAttributes();
 
    void parseSumoBaseObject(CommonXMLStructure::SumoBaseObject* obj);
 
 
    virtual void buildBusStop(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                              const double startPos, const double endPos, const std::string& name, const std::vector<std::string>& lines,
                              const int personCapacity, const double parkingLength, const RGBColor& color, const bool friendlyPosition,
                              const Parameterised::Map& parameters) = 0;
 
    virtual void buildTrainStop(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                const double startPos, const double endPos, const std::string& name, const std::vector<std::string>& lines,
                                const int personCapacity, const double parkingLength, const RGBColor& color, const bool friendlyPosition,
                                const Parameterised::Map& parameters) = 0;
 
    virtual void buildAccess(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& laneID, const std::string& pos,
                             const double length, const bool friendlyPos, const Parameterised::Map& parameters) = 0;
 
    virtual void buildContainerStop(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                    const double startPos, const double endPos, const std::string& name, const std::vector<std::string>& lines,
                                    const int containerCapacity, const double parkingLength, const RGBColor& color, const bool friendlyPosition,
                                    const Parameterised::Map& parameters) = 0;
 
    virtual void buildChargingStation(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                      const double startPos, const double endPos, const std::string& name, const double chargingPower,
                                      const double efficiency, const bool chargeInTransit, const SUMOTime chargeDelay, const std::string& chargeType,
                                      const SUMOTime waitingTime, const bool friendlyPosition, const std::string& parkingAreaID,
                                      const Parameterised::Map& parameters) = 0;
 
    virtual void buildParkingArea(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                  const double startPos, const double endPos, const std::string& departPos, const std::string& name,
                                  const std::vector<std::string>& lines, const bool friendlyPosition, const int roadSideCapacity, const bool onRoad,
                                  const double width, const double length, const double angle, const bool lefthand, const Parameterised::Map& parameters) = 0;
 
    virtual void buildParkingSpace(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const double x, const double y, const double z,
                                   const std::string& name, const std::string& width, const std::string& length, const std::string& angle,
                                   const double slope, const Parameterised::Map& parameters) = 0;
 
    virtual void buildE1Detector(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                 const double position, const SUMOTime period, const std::string& file, const std::vector<std::string>& vehicleTypes,
                                 const std::vector<std::string>& nextEdges, const std::string& detectPersons, const std::string& name,
                                 const bool friendlyPos, const Parameterised::Map& parameters) = 0;
 
    virtual void buildSingleLaneDetectorE2(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                           const double pos, const double length, const SUMOTime period, const std::string& trafficLight, const std::string& filename,
                                           const std::vector<std::string>& vehicleTypes, const std::vector<std::string>& nextEdges, const std::string& detectPersons,
                                           const std::string& name, const SUMOTime timeThreshold, const double speedThreshold, const double jamThreshold,
                                           const bool friendlyPos, const bool show, const Parameterised::Map& parameters) = 0;
 
    virtual void buildMultiLaneDetectorE2(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::vector<std::string>& laneIDs,
                                          const double pos, const double endPos, const SUMOTime period, const std::string& trafficLight, const std::string& filename,
                                          const std::vector<std::string>& vehicleTypes, const std::vector<std::string>& nextEdges, const std::string& detectPersons,
                                          const std::string& name, const SUMOTime timeThreshold, const double speedThreshold, const double jamThreshold,
                                          const bool friendlyPos, const bool show, const Parameterised::Map& parameters) = 0;
 
    virtual void buildDetectorE3(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const Position& pos, const SUMOTime period,
                                 const std::string& filename, const std::vector<std::string>& vehicleTypes, const std::vector<std::string>& nextEdges,
                                 const std::string& detectPersons, const std::string& name, const SUMOTime timeThreshold, const double speedThreshold,
                                 const bool openEntry, const bool expectedArrival, const Parameterised::Map& parameters) = 0;
 
    virtual void buildDetectorEntry(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& laneID, const double pos, const bool friendlyPos,
                                    const Parameterised::Map& parameters) = 0;
 
    virtual void buildDetectorExit(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& laneID, const double pos, const bool friendlyPos,
                                   const Parameterised::Map& parameters) = 0;
 
    virtual void buildDetectorE1Instant(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                        const double pos, const std::string& filename, const std::vector<std::string>& vehicleTypes,
                                        const std::vector<std::string>& nextEdges, const std::string& detectPersons, const std::string& name,
                                        const bool friendlyPos, const Parameterised::Map& parameters) = 0;
 
    virtual void buildLaneCalibrator(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& laneID,
                                     const double pos, const std::string& name, const std::string& outfile, const SUMOTime period, const std::string& routeprobe,
                                     const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters) = 0;
 
    virtual void buildEdgeCalibrator(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& edgeID,
                                     const double pos, const std::string& name, const std::string& outfile, const SUMOTime period, const std::string& routeprobe,
                                     const double jamThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters) = 0;
 
    virtual void buildCalibratorFlow(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameter) = 0;
 
    virtual void buildRerouter(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const Position& pos,
                               const std::vector<std::string>& edgeIDs, const double prob, const std::string& name, const bool off, const bool optional,
                               const SUMOTime timeThreshold, const std::vector<std::string>& vTypes, const Parameterised::Map& parameters) = 0;
 
    virtual void buildRerouterInterval(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOTime begin, const SUMOTime end) = 0;
 
    virtual void buildClosingLaneReroute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& closedLane, SVCPermissions permissions) = 0;
 
    virtual void buildClosingReroute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& closedEdgeID, SVCPermissions permissions) = 0;
 
    virtual void buildDestProbReroute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& newEdgeDestinationID, const double probability) = 0;
 
    virtual void buildParkingAreaReroute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& newParkignAreaID, const double probability, const bool visible) = 0;
 
    virtual void buildRouteProbReroute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& newRouteID, const double probability) = 0;
 
    virtual void buildRouteProbe(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& edgeID, const SUMOTime period,
                                 const std::string& name, const std::string& file, const SUMOTime begin, const std::vector<std::string>& vTypes,
                                 const Parameterised::Map& parameters) = 0;
 
    virtual void buildVariableSpeedSign(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const Position& pos,
                                        const std::vector<std::string>& laneIDs, const std::string& name, const std::vector<std::string>& vTypes,
                                        const Parameterised::Map& parameters) = 0;
 
    virtual void buildVariableSpeedSignStep(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOTime time, const std::string& speed) = 0;
 
    virtual void buildVaporizer(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& edgeID, const SUMOTime from,
                                const SUMOTime endTime, const std::string& name, const Parameterised::Map& parameters) = 0;
 
    virtual void buildTAZ(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const PositionVector& shape,
                          const Position& center, const bool fill, const RGBColor& color, const std::vector<std::string>& edgeIDs,
                          const std::string& name, const Parameterised::Map& parameters) = 0;
 
    virtual void buildTAZSource(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& edgeID, const double departWeight) = 0;
 
    virtual void buildTAZSink(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& edgeID, const double arrivalWeight) = 0;
 
    virtual void buildTractionSubstation(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const Position& pos,
                                         const double voltage, const double currentLimit, const Parameterised::Map& parameters) = 0;
 
    virtual void buildOverheadWire(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& substationId,
                                   const std::vector<std::string>& laneIDs, const double startPos, const double endPos, const bool friendlyPos,
                                   const std::vector<std::string>& forbiddenInnerLanes, const Parameterised::Map& parameters) = 0;
 
    virtual void buildOverheadWireClamp(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& overheadWireIDStartClamp,
                                        const std::string& laneIDStartClamp, const std::string& overheadWireIDEndClamp, const std::string& laneIDEndClamp,
                                        const Parameterised::Map& parameters) = 0;
 
    virtual void buildPolygon(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& type,
                              const RGBColor& color, const double layer, const double angle, const std::string& imgFile, const bool relativePath,
                              const PositionVector& shape, const bool geo, const bool fill, const double lineWidth, const std::string& name,
                              const Parameterised::Map& parameters) = 0;
 
    virtual void buildPOI(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& type,
                          const RGBColor& color, const double x, const double y, const std::string& icon, const double layer,
                          const double angle, const std::string& imgFile, bool relativePath, const double width, const double height,
                          const std::string& name, const Parameterised::Map& parameters) = 0;
 
    virtual void buildPOILane(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& type, const RGBColor& color,
                              const std::string& laneID, const double posOverLane, const bool friendlyPosition, const double posLat, const std::string& icon,
                              const double layer, const double angle, const std::string& imgFile, const bool relativePath, const double width, const double height,
                              const std::string& name, const Parameterised::Map& parameters) = 0;
 
    virtual void buildPOIGeo(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const std::string& type,
                             const RGBColor& color, const double lon, const double lat, const std::string& icon, const double layer,
                             const double angle, const std::string& imgFile, bool relativePath, const double width, const double height,
                             const std::string& name, const Parameterised::Map& parameters) = 0;
 
    virtual void buildJpsWalkableArea(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const PositionVector& shape,
                                      bool geo, const std::string& name, const Parameterised::Map& parameters) = 0;
 
    virtual void buildJpsObstacle(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const PositionVector& shape,
                                  bool geo, const std::string& name, const Parameterised::Map& parameters) = 0;
 
 
    bool isErrorCreatingElement() const;
 
protected:
    void writeError(const std::string& error);
 
private:
    CommonXMLStructure myCommonXMLStructure;
 
    bool myErrorCreatingElement = false;
 
    void parseBusStopAttributes(const SUMOSAXAttributes& attrs);
 
    void parseTrainStopAttributes(const SUMOSAXAttributes& attrs);
 
    void parseAccessAttributes(const SUMOSAXAttributes& attrs);
 
    void parseContainerStopAttributes(const SUMOSAXAttributes& attrs);
 
    void parseChargingStationAttributes(const SUMOSAXAttributes& attrs);
 
    void parseParkingAreaAttributes(const SUMOSAXAttributes& attrs);
 
    void parseParkingSpaceAttributes(const SUMOSAXAttributes& attrs);
 
    void parseE1Attributes(const SUMOSAXAttributes& attrs);
 
    void parseE2Attributes(const SUMOSAXAttributes& attrs);
 
    void parseE3Attributes(const SUMOSAXAttributes& attrs);
 
    void parseEntryAttributes(const SUMOSAXAttributes& attrs);
 
    void parseExitAttributes(const SUMOSAXAttributes& attrs);
 
    void parseE1InstantAttributes(const SUMOSAXAttributes& attrs);
 
    void parseTAZAttributes(const SUMOSAXAttributes& attrs);
 
    void parseTAZSourceAttributes(const SUMOSAXAttributes& attrs);
 
    void parseTAZSinkAttributes(const SUMOSAXAttributes& attrs);
 
    void parseVariableSpeedSignAttributes(const SUMOSAXAttributes& attrs);
 
    void parseVariableSpeedSignStepAttributes(const SUMOSAXAttributes& attrs);
 
    void parseCalibratorAttributes(const SUMOSAXAttributes& attrs);
 
    void parseCalibratorFlowAttributes(const SUMOSAXAttributes& attrs);
 
    void parseRerouterAttributes(const SUMOSAXAttributes& attrs);
 
    void parseRerouterIntervalAttributes(const SUMOSAXAttributes& attrs);
 
    void parseClosingLaneRerouteAttributes(const SUMOSAXAttributes& attrs);
 
    void parseClosingRerouteAttributes(const SUMOSAXAttributes& attrs);
 
    void parseDestProbRerouteAttributes(const SUMOSAXAttributes& attrs);
 
    void parseParkingAreaRerouteAttributes(const SUMOSAXAttributes& attrs);
 
    void parseRouteProbRerouteAttributes(const SUMOSAXAttributes& attrs);
 
    void parseRouteProbeAttributes(const SUMOSAXAttributes& attrs);
 
    void parseVaporizerAttributes(const SUMOSAXAttributes& attrs);
 
    void parseTractionSubstation(const SUMOSAXAttributes& attrs);
 
    void parseOverheadWire(const SUMOSAXAttributes& attrs);
 
    void parseOverheadWireClamp(const SUMOSAXAttributes& attrs);
 
    // @brief parse poly attributes
    void parsePolyAttributes(const SUMOSAXAttributes& attrs);
 
    void parsePOIAttributes(const SUMOSAXAttributes& attrs);
 
    void parseJpsWalkableAreaAttributes(const SUMOSAXAttributes& attrs);
 
    void parseJpsObstacleAttributes(const SUMOSAXAttributes& attrs);
 
    void parseParameters(const SUMOSAXAttributes& attrs);
 
 
    void checkParent(const SumoXMLTag currentTag, const std::vector<SumoXMLTag>& parentTags, bool& ok);
 
    bool checkDetectPersons(const SumoXMLTag currentTag, const std::string& id, const std::string& detectPersons);
 
    AdditionalHandler(const AdditionalHandler& s) = delete;
 
    AdditionalHandler& operator=(const AdditionalHandler& s) = delete;
};