NLBuilder.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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 main interface for loading a microsim
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <map>
#include <vector>
#include <utils/xml/SAXWeightsHandler.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSNet;
class NLContainer;
class MSJunctionLogic;
class MSDetectorControl;
class OptionsCont;
class NLHandler;
class NLEdgeControlBuilder;
class NLJunctionControlBuilder;
class NLDetectorBuilder;
class NLTriggerBuilder;
class SUMORouteLoader;
class SUMORouteLoaderControl;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NLBuilder {
public:
    NLBuilder(OptionsCont& oc, MSNet& net,
              NLEdgeControlBuilder& eb, NLJunctionControlBuilder& jb,
              NLDetectorBuilder& db,
              NLHandler& xmlHandler);
 
 
    virtual ~NLBuilder();
 
 
    virtual bool build();
 
    static MSNet* init(const bool isLibsumo = false);
 
    static void initRandomness();
 
    static SUMORouteLoaderControl* buildRouteLoaderControl(const OptionsCont& oc);
 
protected:
    bool load(const std::string& mmlWhat, const bool isNet = false);
 
    bool loadMesoEdgeTypes(const std::string& mmlWhat);
 
 
    void buildNet();
 
    void buildDefaultMeanData(const std::string& optionName, const std::string& id, bool useLanes);
 
    class EdgeFloatTimeLineRetriever_EdgeEffort : public SAXWeightsHandler::EdgeFloatTimeLineRetriever {
    public:
        EdgeFloatTimeLineRetriever_EdgeEffort(MSNet& net) : myNet(net) {}
 
        ~EdgeFloatTimeLineRetriever_EdgeEffort() { }
 
        void addEdgeWeight(const std::string& id,
                           double val, double beg, double end) const;
 
    private:
        MSNet& myNet;
 
    };
 
 
    class EdgeFloatTimeLineRetriever_EdgeTravelTime : public SAXWeightsHandler::EdgeFloatTimeLineRetriever {
    public:
        EdgeFloatTimeLineRetriever_EdgeTravelTime(MSNet& net) : myNet(net) {}
 
        ~EdgeFloatTimeLineRetriever_EdgeTravelTime() { }
 
        void addEdgeWeight(const std::string& id,
                           double val, double beg, double end) const;
 
    private:
        MSNet& myNet;
 
    };
 
 
protected:
    OptionsCont& myOptions;
 
    NLEdgeControlBuilder& myEdgeBuilder;
 
    NLJunctionControlBuilder& myJunctionBuilder;
 
    NLDetectorBuilder& myDetectorBuilder;
 
    MSNet& myNet;
 
    NLHandler& myXMLHandler;
 
 
private:
    NLBuilder(const NLBuilder& s);
 
    NLBuilder& operator=(const NLBuilder& s);
 
};