MSRoute.cpp

Go to the documentation of this file.

/****************************************************************************/
// A vehicle route
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 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.
//
/****************************************************************************/


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

#include <cassert>
#include <algorithm>
#include <limits>
#include "MSRoute.h"
#include "MSEdge.h"
#include "MSLane.h"
#include <utils/common/FileHelpers.h>
#include <utils/common/RGBColor.h>
#include <utils/iodevices/BinaryInputDevice.h>
#include <utils/iodevices/OutputDevice.h>

#ifdef CHECK_MEMORY_LEAKS
#include <foreign/nvwa/debug_new.h>
#endif // CHECK_MEMORY_LEAKS


// ===========================================================================
// static member variables
// ===========================================================================
MSRoute::RouteDict MSRoute::myDict;
MSRoute::RouteDistDict MSRoute::myDistDict;


// ===========================================================================
// member method definitions
// ===========================================================================
MSRoute::MSRoute(const std::string& id,
                 const MSEdgeVector& edges,
                 unsigned int references, const RGBColor& c,
                 const std::vector<SUMOVehicleParameter::Stop> &stops) throw()
    : Named(id), myEdges(edges),
      myReferenceCounter(references),
      myColor(c), myStops(stops) {}


MSRoute::~MSRoute() throw() {}

MSRouteIterator
MSRoute::begin() const {
    return myEdges.begin();
}

MSRouteIterator
MSRoute::end() const {
    return myEdges.end();
}

unsigned
MSRoute::size() const {
    return (unsigned) myEdges.size();
}


const MSEdge*
MSRoute::getLastEdge() const {
    assert(myEdges.size()>0);
    return myEdges[myEdges.size()-1];
}


void
MSRoute::addReference() const {
    myReferenceCounter++;
}


void
MSRoute::release() const {
    myReferenceCounter--;
    if (myReferenceCounter == 0) {
        myDict.erase(myID);
        delete this;
    }
}


bool
MSRoute::dictionary(const std::string& id, const MSRoute* route) {
    if (myDict.find(id) == myDict.end() && myDistDict.find(id) == myDistDict.end()) {
        myDict[id] = route;
        return true;
    }
    return false;
}


bool
MSRoute::dictionary(const std::string& id, RandomDistributor<const MSRoute*>* routeDist) {
    if (myDict.find(id) == myDict.end() && myDistDict.find(id) == myDistDict.end()) {
        myDistDict[id] = routeDist;
        return true;
    }
    return false;
}


const MSRoute*
MSRoute::dictionary(const std::string& id) {
    RouteDict::iterator it = myDict.find(id);
    if (it == myDict.end()) {
        RouteDistDict::iterator it2 = myDistDict.find(id);
        if (it2 == myDistDict.end() || it2->second->getOverallProb() == 0) {
            return 0;
        }
        return it2->second->get();
    }
    return it->second;
}


RandomDistributor<const MSRoute*> *
MSRoute::distDictionary(const std::string& id) {
    RouteDistDict::iterator it2 = myDistDict.find(id);
    if (it2 == myDistDict.end()) {
        return 0;
    }
    return it2->second;
}


void
MSRoute::clear() {
    for (RouteDistDict::iterator i=myDistDict.begin(); i!=myDistDict.end(); ++i) {
        delete i->second;
    }
    myDistDict.clear();
    for (RouteDict::iterator i=myDict.begin(); i!=myDict.end(); ++i) {
        delete i->second;
    }
    myDict.clear();
}


void
MSRoute::insertIDs(std::vector<std::string> &into) {
    into.reserve(myDict.size()+myDistDict.size()+into.size());
    for (RouteDict::const_iterator i=myDict.begin(); i!=myDict.end(); ++i) {
        into.push_back((*i).first);
    }
    for (RouteDistDict::const_iterator i=myDistDict.begin(); i!=myDistDict.end(); ++i) {
        into.push_back((*i).first);
    }
}


void
MSRoute::writeEdgeIDs(OutputDevice& os, const MSEdge* const from, const MSEdge* const upTo) const {
    MSEdgeVector::const_iterator i = myEdges.begin();
    if (from != 0) {
        i = std::find(myEdges.begin(), myEdges.end(), from);
    }
    for (; i != myEdges.end(); ++i) {
        if ((*i) == upTo) {
            return;
        }
        os << (*i)->getID();
        if (upTo || i!=myEdges.end()-1) {
            os << ' ';
        }
    }
}


bool
MSRoute::containsAnyOf(const std::vector<MSEdge*> &edgelist) const {
    std::vector<MSEdge*>::const_iterator i = edgelist.begin();
    for (; i!=edgelist.end(); ++i) {
        if (contains(*i)) {
            return true;
        }
    }
    return false;
}


const MSEdge*
MSRoute::operator[](unsigned index) const {
    return myEdges[index];
}


#ifdef HAVE_MESOSIM
void
MSRoute::dict_saveState(std::ostream& os) throw() {
    FileHelpers::writeUInt(os, (unsigned int) myDict.size());
    for (RouteDict::iterator it = myDict.begin(); it!=myDict.end(); ++it) {
        FileHelpers::writeString(os, (*it).second->getID());
        const MSEdgeVector& edges = (*it).second->myEdges;
        FileHelpers::writeUInt(os, (unsigned int)edges.size());
        FileHelpers::writeUInt(os, (*it).second->myReferenceCounter);
        std::vector<unsigned int> follow;
        unsigned int maxFollow = 0;
        const MSEdge* prev = edges.front();
        for (MSEdgeVector::const_iterator i = edges.begin()+1; i != edges.end(); ++i) {
            unsigned int idx = 0;
            for (; idx < prev->getNoFollowing(); ++idx) {
                if (idx > 15) {
                    break;
                }
                if (prev->getFollower(idx) == (*i)) {
                    follow.push_back(idx);
                    if (idx > maxFollow) {
                        maxFollow = idx;
                    }
                    break;
                }
            }
            if (idx > 15 || idx == prev->getNoFollowing()) {
                follow.clear();
                break;
            }
            prev = *i;
        }
        if (follow.empty()) {
            for (MSEdgeVector::const_iterator i = edges.begin(); i != edges.end(); ++i) {
                FileHelpers::writeInt(os, (*i)->getNumericalID());
            }
        } else {
            const unsigned int bits = maxFollow > 3 ? 4 : 2;
            const unsigned int numFields = 8 * sizeof(unsigned int) / bits;
            FileHelpers::writeInt(os, -bits);
            FileHelpers::writeUInt(os, edges.front()->getNumericalID());
            unsigned int data = 0;
            unsigned int field = 0;
            for (std::vector<unsigned int>::const_iterator i = follow.begin(); i != follow.end(); ++i) {
                data |= *i;
                field++;
                if (field == numFields) {
                    FileHelpers::writeUInt(os, data);
                    data = 0;
                    field = 0;
                } else {
                    data <<= bits;
                }
            }
            if (field > 0) {
                FileHelpers::writeUInt(os, data << ((numFields-field-1) * bits));
            }
        }
    }
    FileHelpers::writeUInt(os, (unsigned int) myDistDict.size());
    for (RouteDistDict::iterator it = myDistDict.begin(); it!=myDistDict.end(); ++it) {
        FileHelpers::writeString(os, (*it).first);
        const unsigned int size = (unsigned int)(*it).second->getVals().size();
        FileHelpers::writeUInt(os, size);
        for (unsigned int i = 0; i < size; ++i) {
            FileHelpers::writeString(os, (*it).second->getVals()[i]->getID());
            FileHelpers::writeFloat(os, (*it).second->getProbs()[i]);
        }
    }
}


void
MSRoute::dict_loadState(BinaryInputDevice& bis) throw() {
    unsigned int numRoutes;
    bis >> numRoutes;
    for (; numRoutes>0; numRoutes--) {
        std::string id;
        bis >> id;
        unsigned int numEdges;
        bis >> numEdges;
        unsigned int references;
        bis >> references;
        int first;
        bis >> first;
        if (first < 0) {
            const unsigned int bits = -first;
            const unsigned int numFields = 8 * sizeof(unsigned int) / bits;
            if (dictionary(id)==0) {
                const unsigned int mask = (1 << bits) - 1;
                MSEdgeVector edges;
                edges.reserve(numEdges);
                unsigned int edgeID;
                bis >> edgeID;
                const MSEdge* prev = MSEdge::dictionary(edgeID);
                assert(prev!=0);
                edges.push_back(prev);
                numEdges--;
                unsigned int data;
                unsigned int field = numFields;
                for (; numEdges > 0; numEdges--) {
                    if (field == numFields) {
                        bis >> data;
                        field = 0;
                    }
                    unsigned int followIndex = (data >> ((numFields - field - 1) * bits)) & mask;
                    prev = prev->getFollower(followIndex);
                    edges.push_back(prev);
                    field++;
                }
                MSRoute* r = new MSRoute(id, edges, references,
                                         RGBColor::DEFAULT_COLOR, std::vector<SUMOVehicleParameter::Stop>());
                dictionary(id, r);
            } else {
                unsigned int data;
                bis >> data; // first edge id
                for (int numFollows = numEdges - 1; numFollows > 0; numFollows -= numFields) {
                    bis >> data;
                }
            }
        } else {
            if (dictionary(id)==0) {
                MSEdgeVector edges;
                edges.reserve(numEdges);
                edges.push_back(MSEdge::dictionary(first));
                numEdges--;
                for (; numEdges>0; numEdges--) {
                    unsigned int edgeID;
                    bis >> edgeID;
                    assert(MSEdge::dictionary(edgeID)!=0);
                    edges.push_back(MSEdge::dictionary(edgeID));
                }
                MSRoute* r = new MSRoute(id, edges, references,
                                         RGBColor::DEFAULT_COLOR, std::vector<SUMOVehicleParameter::Stop>());
                dictionary(id, r);
            } else {
                numEdges--;
                for (; numEdges>0; numEdges--) {
                    unsigned int edgeID;
                    bis >> edgeID;
                }
            }
        }
    }
    unsigned int numRouteDists;
    bis >> numRouteDists;
    for (; numRouteDists>0; numRouteDists--) {
        std::string id;
        bis >> id;
        unsigned int no;
        bis >> no;
        if (dictionary(id)==0) {
            RandomDistributor<const MSRoute*> *dist = new RandomDistributor<const MSRoute*>();
            for (; no>0; no--) {
                std::string routeID;
                bis >> routeID;
                const MSRoute* r = dictionary(routeID);
                assert(r!=0);
                SUMOReal prob;
                bis >> prob;
                dist->add(prob, r, false);
            }
            dictionary(id, dist);
        } else {
            for (; no>0; no--) {
                std::string routeID;
                bis >> routeID;
                SUMOReal prob;
                bis >> prob;
            }
        }
    }
}
#endif


SUMOReal
MSRoute::getLength() const {
    SUMOReal ret = 0;
    for (MSEdgeVector::const_iterator i=myEdges.begin(); i!=myEdges.end(); ++i) {
        ret += (*i)->getLanes()[0]->getLength();
    }
    return ret;
}


SUMOReal
MSRoute::getDistanceBetween(SUMOReal fromPos, SUMOReal toPos, const MSEdge* fromEdge, const MSEdge* toEdge) const {
    bool isFirstIteration = true;
    SUMOReal distance = -fromPos;
    MSEdgeVector::const_iterator it = std::find(myEdges.begin(), myEdges.end(), fromEdge);

    if (it == myEdges.end() || std::find(it, myEdges.end(), toEdge) == myEdges.end()) {
        // start or destination not contained in route
        return std::numeric_limits<SUMOReal>::max();
    }
    if (fromEdge == toEdge && fromPos <= toPos) {
        // destination position is on start edge
        return (toPos - fromPos);
    }
    for (; it!=end(); ++it) {
        if ((*it) == toEdge && !isFirstIteration) {
            distance += toPos;
            break;
        } else {
            const std::vector<MSLane*>& lanes = (*it)->getLanes();
            distance += lanes[0]->getLength();
#ifdef HAVE_INTERNAL_LANES
            // add length of internal lanes to the result
            for (std::vector<MSLane*>::const_iterator laneIt = lanes.begin(); laneIt != lanes.end(); laneIt++) {
                const MSLinkCont& links = (*laneIt)->getLinkCont();
                for (MSLinkCont::const_iterator linkIt = links.begin(); linkIt != links.end(); linkIt++) {
                    if ((*linkIt)==0||(*linkIt)->getLane()==0) {
                        continue;
                    }
                    std::string succLaneId = (*(it+1))->getLanes()[0]->getID();
                    if ((*linkIt)->getLane()->getID().compare(succLaneId) == 0) {
                        distance += (*linkIt)->getLength();
                    }
                }
            }
#endif
        }
        isFirstIteration = false;
    }
    return distance;
}


const RGBColor&
MSRoute::getColor() const {
    return myColor;
}


const std::vector<SUMOVehicleParameter::Stop> &
MSRoute::getStops() const {
    return myStops;
}


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