MSNet.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// The simulated network and simulation performer
/****************************************************************************/
#ifndef MSNet_h
#define MSNet_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <typeinfo>
#include <vector>
#include <map>
#include <string>
#include <fstream>
#include <iostream>
#include <cmath>
#include <iomanip>
#include <utils/common/SUMOTime.h>
#include <utils/common/UtilExceptions.h>
#include <utils/common/NamedObjectCont.h>
#include <utils/common/NamedRTree.h>
#include <utils/vehicle/SUMOAbstractRouter.h>
#include <microsim/trigger/MSChargingStation.h>
#include "MSJunction.h"
#include "MSParkingArea.h"
#include "MSStoppingPlace.h"


// ===========================================================================
// class declarations
// ===========================================================================
class MSEdge;
class MSEdgeControl;
class MSEventControl;
class MSVehicleControl;
class MSJunctionControl;
class MSInsertionControl;
class SUMORouteLoaderControl;
class MSTransportableControl;
class MSVehicle;
class MSRoute;
class MSLane;
class MSTLLogicControl;
class MSTrafficLightLogic;
class MSDetectorControl;
class ShapeContainer;
class BinaryInputDevice;
class MSEdgeWeightsStorage;
class SUMOVehicle;
template<class E, class L, class N, class V>
class IntermodalRouter;
template<class E, class L, class N, class V>
class PedestrianRouter;


// ===========================================================================
// class definitions
// ===========================================================================
class MSNet {
public:
    enum SimulationState {
        SIMSTATE_LOADING,
        SIMSTATE_RUNNING,
        SIMSTATE_END_STEP_REACHED,
        SIMSTATE_NO_FURTHER_VEHICLES,
        SIMSTATE_CONNECTION_CLOSED,
        SIMSTATE_ERROR_IN_SIM,
        SIMSTATE_TOO_MANY_TELEPORTS
    };

    typedef PedestrianRouter<MSEdge, MSLane, MSJunction, MSVehicle> MSPedestrianRouter;
    typedef IntermodalRouter<MSEdge, MSLane, MSJunction, SUMOVehicle> MSIntermodalRouter;


public:
    static MSNet* getInstance();


    static bool hasInstance() {
        return myInstance != nullptr;
    }


    MSNet(MSVehicleControl* vc, MSEventControl* beginOfTimestepEvents,
          MSEventControl* endOfTimestepEvents,
          MSEventControl* insertionEvents,
          ShapeContainer* shapeCont = 0);


    virtual ~MSNet();


    void closeBuilding(const OptionsCont& oc, MSEdgeControl* edges, MSJunctionControl* junctions,
                       SUMORouteLoaderControl* routeLoaders, MSTLLogicControl* tlc,
                       std::vector<SUMOTime> stateDumpTimes, std::vector<std::string> stateDumpFiles,
                       bool hasInternalLinks, bool hasNeighs, bool lefthand,
                       double version);


    bool hasPermissions() const {
        return myHavePermissions;
    }


    void setPermissionsFound() {
        myHavePermissions = true;
    }


    void addRestriction(const std::string& id, const SUMOVehicleClass svc, const double speed);


    const std::map<SUMOVehicleClass, double>* getRestrictions(const std::string& id) const;


    static void clearAll();


    SimulationState simulate(SUMOTime start, SUMOTime stop);


    void simulationStep();


    void loadRoutes();


    void closeSimulation(SUMOTime start);


    SimulationState simulationState(SUMOTime stopTime) const;


    static std::string getStateMessage(SimulationState state);


    inline SUMOTime getCurrentTimeStep() const {
        return myStep;
    }


    inline void setCurrentTimeStep(const SUMOTime step) {
        myStep = step;
    }


    void writeOutput();


    bool logSimulationDuration() const;





    void preSimStepOutput() const;


    void postSimStepOutput() const;
    //}




    MSVehicleControl& getVehicleControl() {
        return *myVehicleControl;
    }


    virtual MSTransportableControl& getPersonControl();

    bool hasPersons() const {
        return myPersonControl != 0;
    }

    virtual MSTransportableControl& getContainerControl();

    bool hasContainers() const {
        return myContainerControl != 0;
    }


    MSEdgeControl& getEdgeControl() {
        return *myEdges;
    }


    MSInsertionControl& getInsertionControl() {
        return *myInserter;
    }


    MSDetectorControl& getDetectorControl() {
        return *myDetectorControl;
    }


    MSTLLogicControl& getTLSControl() {
        return *myLogics;
    }


    MSJunctionControl& getJunctionControl() {
        return *myJunctions;
    }


    MSEventControl* getBeginOfTimestepEvents() {
        return myBeginOfTimestepEvents;
    }


    MSEventControl* getEndOfTimestepEvents() {
        return myEndOfTimestepEvents;
    }


    MSEventControl* getInsertionEvents() {
        return myInsertionEvents;
    }


    ShapeContainer& getShapeContainer() {
        return *myShapeContainer;
    }

    MSEdgeWeightsStorage& getWeightsStorage();


    bool addStoppingPlace(const SumoXMLTag category, MSStoppingPlace* stop);


    MSStoppingPlace* getStoppingPlace(const std::string& id, const SumoXMLTag category) const;

    std::string getStoppingPlaceID(const MSLane* lane, const double pos, const SumoXMLTag category) const;


    void writeChargingStationOutput() const;

    virtual void createTLWrapper(MSTrafficLightLogic*) {};


    enum VehicleState {
        VEHICLE_STATE_BUILT,
        VEHICLE_STATE_DEPARTED,
        VEHICLE_STATE_STARTING_TELEPORT,
        VEHICLE_STATE_ENDING_TELEPORT,
        VEHICLE_STATE_ARRIVED,
        VEHICLE_STATE_NEWROUTE,
        VEHICLE_STATE_STARTING_PARKING,
        VEHICLE_STATE_ENDING_PARKING,
        VEHICLE_STATE_STARTING_STOP,
        VEHICLE_STATE_ENDING_STOP,
        VEHICLE_STATE_COLLISION,
        VEHICLE_STATE_EMERGENCYSTOP
    };


    class VehicleStateListener {
    public:
        VehicleStateListener() { }

        virtual ~VehicleStateListener() { }

        virtual void vehicleStateChanged(const SUMOVehicle* const vehicle, VehicleState to, const std::string& info = "") = 0;

    };


    void addVehicleStateListener(VehicleStateListener* listener);


    void removeVehicleStateListener(VehicleStateListener* listener);


    void informVehicleStateListener(const SUMOVehicle* const vehicle, VehicleState to, const std::string& info = "");



    static double getTravelTime(const MSEdge* const e, const SUMOVehicle* const v, double t);


    static double getEffort(const MSEdge* const e, const SUMOVehicle* const v, double t);


    /* @brief get the router, initialize on first use
     * @param[in] prohibited The vector of forbidden edges (optional)
     */
    SUMOAbstractRouter<MSEdge, SUMOVehicle>& getRouterTT(
        const MSEdgeVector& prohibited = MSEdgeVector()) const;
    SUMOAbstractRouter<MSEdge, SUMOVehicle>& getRouterEffort(
        const MSEdgeVector& prohibited = MSEdgeVector()) const;
    MSPedestrianRouter& getPedestrianRouter(const MSEdgeVector& prohibited = MSEdgeVector()) const;
    MSIntermodalRouter& getIntermodalRouter(const int routingMode = 0, const MSEdgeVector& prohibited = MSEdgeVector()) const;

    static void adaptIntermodalRouter(MSIntermodalRouter& router);


    const NamedRTree& getLanesRTree() const;

    bool hasInternalLinks() const {
        return myHasInternalLinks;
    }

    bool hasElevation() const {
        return myHasElevation;
    }

    bool lefthand() const {
        return myLefthand;
    }

    double getNetworkVersion() const {
        return myVersion;
    }

    bool warnOnce(const std::string& typeAndID);


protected:
    bool checkElevation();


protected:
    static MSNet* myInstance;

    SUMORouteLoaderControl* myRouteLoaders;

    SUMOTime myStep;

    int myMaxTeleports;




    MSVehicleControl* myVehicleControl;
    MSTransportableControl* myPersonControl;
    MSTransportableControl* myContainerControl;
    MSEdgeControl* myEdges;
    MSJunctionControl* myJunctions;
    MSTLLogicControl* myLogics;
    MSInsertionControl* myInserter;
    MSDetectorControl* myDetectorControl;
    MSEventControl* myBeginOfTimestepEvents;
    MSEventControl* myEndOfTimestepEvents;
    MSEventControl* myInsertionEvents;
    ShapeContainer* myShapeContainer;
    MSEdgeWeightsStorage* myEdgeWeights;




    bool myLogExecutionTime;

    bool myLogStepNumber;

    long myTraCIStepDuration, mySimStepDuration;

    long mySimBeginMillis;

    long long int myVehiclesMoved;
    //}




    std::vector<SUMOTime> myStateDumpTimes;
    std::vector<std::string> myStateDumpFiles;
    SUMOTime myStateDumpPeriod;
    std::string myStateDumpPrefix;
    std::string myStateDumpSuffix;



    bool myHavePermissions;

    std::map<std::string, std::map<SUMOVehicleClass, double> > myRestrictions;

    bool myHasInternalLinks;

    bool myHasElevation;

    bool myLefthand;

    double myVersion;

    std::map<SumoXMLTag, NamedObjectCont<MSStoppingPlace*> > myStoppingPlaces;

    std::vector<VehicleStateListener*> myVehicleStateListeners;

    std::map<std::string, bool> myWarnedOnce;

    /* @brief The router instance for routing by trigger and by traci
     * @note MSDevice_Routing has its own instance since it uses a different weight function
     * @note we provide one member for every switchable router type
     * because the class structure makes it inconvenient to use a superclass*/
    mutable SUMOAbstractRouter<MSEdge, SUMOVehicle>* myRouterTT;
    mutable SUMOAbstractRouter<MSEdge, SUMOVehicle>* myRouterEffort;
    mutable MSPedestrianRouter* myPedestrianRouter;
    mutable std::map<int, MSIntermodalRouter*> myIntermodalRouter;


    mutable std::pair<bool, NamedRTree> myLanesRTree;


    static const std::string STAGE_EVENTS;
    static const std::string STAGE_MOVEMENTS;
    static const std::string STAGE_LANECHANGE;
    static const std::string STAGE_INSERTIONS;

private:
    MSNet(const MSNet&);

    MSNet& operator=(const MSNet&);


};


#endif

/****************************************************************************/