MSRoute.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2002-2017 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
//
/****************************************************************************/
// A vehicle route
/****************************************************************************/
#ifndef MSRoute_h
#define MSRoute_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <map>
#include <vector>
#include <algorithm>
#include <utils/common/Named.h>
#include <utils/distribution/RandomDistributor.h>
#include <utils/common/RGBColor.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/common/Parameterised.h>
#ifdef HAVE_FOX
#include <fx.h>
#include <FXThread.h>
#endif


// ===========================================================================
// class declarations
// ===========================================================================
class MSEdge;
class BinaryInputDevice;
class OutputDevice;


// ===========================================================================
// types definitions
// ===========================================================================
typedef std::vector<const MSEdge*> ConstMSEdgeVector;
typedef std::vector<MSEdge*> MSEdgeVector;
typedef ConstMSEdgeVector::const_iterator MSRouteIterator;


// ===========================================================================
// class definitions
// ===========================================================================
class MSRoute : public Named, public Parameterised {
public:
    MSRoute(const std::string& id, const ConstMSEdgeVector& edges,
            const bool isPermanent, const RGBColor* const c,
            const std::vector<SUMOVehicleParameter::Stop>& stops);

    virtual ~MSRoute();

    MSRouteIterator begin() const;

    MSRouteIterator end() const;

    int size() const;

    const MSEdge* getLastEdge() const;

    void addReference() const;

    void release() const;

    int writeEdgeIDs(OutputDevice& os, const MSEdge* const from, const MSEdge* const upTo = 0) const;

    bool contains(const MSEdge* const edge) const {
        return std::find(myEdges.begin(), myEdges.end(), edge) != myEdges.end();
    }

    bool containsAnyOf(const MSEdgeVector& edgelist) const;

    const MSEdge* operator[](int index) const;


    static void dict_saveState(OutputDevice& out);

    const ConstMSEdgeVector& getEdges() const {
        return myEdges;
    }

    double getDistanceBetween(double fromPos, double toPos, const MSEdge* fromEdge, const MSEdge* toEdge, bool includeInternal = true) const;

    double getDistanceBetween(double fromPos, double toPos, const MSRouteIterator& fromEdge, const MSRouteIterator& toEdge, bool includeInternal = true) const;

    const RGBColor& getColor() const;

    double getCosts() const {
        return myCosts;
    }

    void setCosts(double costs) {
        myCosts = costs;
    }

    const std::vector<SUMOVehicleParameter::Stop>& getStops() const;

public:
    static bool dictionary(const std::string& id, const MSRoute* route);

    static bool dictionary(const std::string& id, RandomDistributor<const MSRoute*>* const routeDist, const bool permanent = true);

    static const MSRoute* dictionary(const std::string& id, std::mt19937* rng = 0);

    static RandomDistributor<const MSRoute*>* distDictionary(const std::string& id);

    static void clear();

    static void checkDist(const std::string& id);

    static void insertIDs(std::vector<std::string>& into);

private:
    ConstMSEdgeVector myEdges;

    const bool myAmPermanent;

    mutable int myReferenceCounter;

    const RGBColor* const myColor;

    double myCosts;

    std::vector<SUMOVehicleParameter::Stop> myStops;

private:
    typedef std::map<std::string, const MSRoute*> RouteDict;

    static RouteDict myDict;

    typedef std::map<std::string, std::pair<RandomDistributor<const MSRoute*>*, bool> > RouteDistDict;

    static RouteDistDict myDistDict;

#ifdef HAVE_FOX
    static FXMutex myDictMutex;
#endif
private:
    MSRoute& operator=(const MSRoute& s);

};


#endif

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