MSRoute.h

Go to the documentation of this file.

/****************************************************************************/
// A vehicle route
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#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 <utils/common/Named.h>
#include <utils/common/RandomDistributor.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOVehicleParameter.h>


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


typedef std::vector<const MSEdge*> MSEdgeVector;
typedef MSEdgeVector::const_iterator MSRouteIterator;


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

    virtual ~MSRoute() throw();

    MSRouteIterator begin() const;

    MSRouteIterator end() const;

    unsigned size() const;

    const MSEdge *getLastEdge() const;

    bool inFurtherUse() const;

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

    bool contains(const MSEdge * const edge) const throw() {
        return find(edge)!=myEdges.end();
    }

    bool containsAnyOf(const std::vector<MSEdge*> &edgelist) const;

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

#ifdef HAVE_MESOSIM


    static void dict_saveState(std::ostream &os) throw();


    static void dict_loadState(BinaryInputDevice &bis) throw();
#endif

    unsigned posInRoute(const MSRouteIterator &currentEdge) const;

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

    SUMOReal getLength() const;

    SUMOReal getDistanceBetween(SUMOReal fromPos, SUMOReal toPos, const MSEdge* fromEdge, const MSEdge* toEdge) const;

    const RGBColor &getColor() const;

    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*> *routeDist);

    static const MSRoute *dictionary(const std::string &id);

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

    static void clear();

    static void erase(std::string id);

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

    MSRouteIterator find(const MSEdge *e) const;
    MSRouteIterator find(const MSEdge *e, const MSRouteIterator &startingAt) const;


private:
    MSEdgeVector myEdges;

    bool myMultipleReferenced;

    RGBColor myColor;

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

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

    static RouteDict myDict;

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

    static RouteDistDict myDistDict;

};


#endif

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