NLTriggerBuilder.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-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
/****************************************************************************/
// Builds trigger objects for microsim
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <utils/common/RGBColor.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSTrigger;
class MSNet;
class MSLaneSpeedTrigger;
class NLHandler;
class MSTriggeredRerouter;
class MSLane;
class MSEdge;
class MSStoppingPlace;
class MSCalibrator;
class MSRouteProbe;
 
class METriggeredCalibrator;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NLTriggerBuilder {
public:
    NLTriggerBuilder();
 
 
    virtual ~NLTriggerBuilder();
 
    void setHandler(NLHandler* handler);
 
 
    void buildVaporizer(const SUMOSAXAttributes& attrs);
 
 
 
 
    void parseAndBuildLaneSpeedTrigger(MSNet& net, const SUMOSAXAttributes& attrs,
                                       const std::string& base);
 
 
    void parseAndBuildRerouter(MSNet& net, const SUMOSAXAttributes& attrs);
 
 
    void parseAndBuildStoppingPlace(MSNet& net, const SUMOSAXAttributes& attrs, const SumoXMLTag element);
 
 
    virtual void beginParkingArea(MSNet& net,
                                  const std::string& id, const std::vector<std::string>& lines,
                                  const std::vector<std::string>& badges,
                                  MSLane* lane, double frompos, double topos,
                                  unsigned int capacity,
                                  double width, double length, double angle, const std::string& name,
                                  bool onRoad,
                                  const std::string& departPos,
                                  bool lefthand);
 
 
    void addLotEntry(double x, double y, double z,
                     double width, double length,
                     double angle, double slope);
 
 
 
    void addAccess(MSNet& net, const SUMOSAXAttributes& attrs);
 
 
    void parseAndBeginParkingArea(MSNet& net, const SUMOSAXAttributes& attrs);
 
 
    void parseAndAddLotEntry(const SUMOSAXAttributes& attrs);
 
 
    virtual void endParkingArea();
 
    virtual void endStoppingPlace();
 
 
    void parseAndBuildChargingStation(MSNet& net, const SUMOSAXAttributes& attrs);
 
    void parseAndBuildOverheadWireSegment(MSNet& net, const SUMOSAXAttributes& attrs);
 
    void parseAndBuildOverheadWireSection(MSNet& net, const SUMOSAXAttributes& attrs);
 
    void parseAndBuildTractionSubstation(MSNet& net, const SUMOSAXAttributes& attrs);
 
    void parseAndBuildOverheadWireClamp(MSNet& net, const SUMOSAXAttributes& attrs);
 
    void parseAndBuildCalibrator(MSNet& net, const SUMOSAXAttributes& attrs,
                                 const std::string& base);
 
    void updateParkingAreaDefaultCapacity();
 
 
    MSStoppingPlace* getCurrentStop();
 
 
protected:
 
 
    virtual MSLaneSpeedTrigger* buildLaneSpeedTrigger(MSNet& net,
            const std::string& id, const std::vector<MSLane*>& destLanes,
            const std::string& file);
 
 
    virtual void buildStoppingPlace(MSNet& net, std::string id, std::vector<std::string> lines, MSLane* lane,
                                    double frompos, double topos, const SumoXMLTag element, std::string string,
                                    int personCapacity, double parkingLength, RGBColor& color);
 
    virtual void buildChargingStation(MSNet& net, const std::string& id, MSLane* lane, double frompos, double topos, const std::string& name,
                                      double chargingPower, double efficiency, bool chargeInTransit, SUMOTime chargeDelay, std::string chargeType,
                                      SUMOTime waitingTime, MSParkingArea* parkingArea);
 
    virtual void buildOverheadWireSegment(MSNet& net, const std::string& id, MSLane* lane, double frompos, double topos, bool voltageSource);
 
    void buildInnerOverheadWireSegments(MSNet& net, const MSLane* connection, const MSLane* frontConnection, const MSLane* behindConnection);
 
    void buildTractionSubstation(MSNet& net, std::string id, double voltage, double currentLimit);
 
    virtual void buildOverheadWireClamp(MSNet& net, const std::string& id, MSLane* lane_start, MSLane* lane_end);
 
    virtual MSCalibrator* buildCalibrator(const std::string& id, MSEdge* edge, MSLane* lane, MSJunction* node, double pos,
                                          const std::string& file, const std::string& outfile,
                                          const SUMOTime freq,
                                          const MSRouteProbe* probe,
                                          const double invalidJamThreshold,
                                          const std::string& vTypes,
                                          const bool local);
 
    virtual METriggeredCalibrator* buildMECalibrator(const std::string& id, MSEdge* edge, double pos,
            const std::string& file, const std::string& outfile,
            const SUMOTime freq,
            MSRouteProbe* probe,
            const double invalidJamThreshold,
            const std::string& vTypes);
 
 
    virtual MSTriggeredRerouter* buildRerouter(MSNet& net,
            const std::string& id, MSEdgeVector& edges,
            double prob, bool off, bool optional, SUMOTime timeThreshold,
            const std::string& vTypes, const Position& pos);
 
 
protected:
 
    std::string getFileName(const SUMOSAXAttributes& attrs,
                            const std::string& base,
                            const bool allowEmpty = false);
 
 
    MSLane* getLane(const SUMOSAXAttributes& attrs,
                    const std::string& tt, const std::string& tid);
 
 
    MSParkingArea* getParkingArea(const SUMOSAXAttributes& attrs,
                                  const std::string& tt, const std::string& tid);
 
 
    double getPosition(const SUMOSAXAttributes& attrs,
                       MSLane* lane, const std::string& tt, const std::string& tid, MSEdge* edge = 0);
 
 
 
 
 
protected:
    NLHandler* myHandler;
    MSParkingArea* myParkingArea;
    MSStoppingPlace* myCurrentStop;
 
    bool myHaveWarnedAboutEigen = false;
    bool myParkingAreaCapacitySet = false;
};