RORoute.h

Go to the documentation of this file.

/****************************************************************************/
// A complete router's 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 RORoute_h
#define RORoute_h


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

#include <string>
#include <utils/common/Named.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOAbstractRouter.h>


// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class RORoute : public Named {
public:
    RORoute(const std::string &id, SUMOReal costs, SUMOReal prob,
            const std::vector<const ROEdge*> &route, const RGBColor * const color) throw();


    RORoute(const RORoute &src) throw();


    ~RORoute() throw();


    void add(ROEdge *edge) throw();


    const ROEdge *getFirst() const throw() {
        return myRoute[0];
    }


    const ROEdge *getLast() const throw() {
        return myRoute.back();
    }


    SUMOReal getCosts() const throw() {
        return myCosts;
    }


    SUMOReal getProbability() const throw() {
        return myProbability;
    }


    void setCosts(SUMOReal costs) throw();


    void setProbability(SUMOReal prob) throw();


    unsigned int size() const throw() {
        return (unsigned int) myRoute.size();
    }


    const std::vector<const ROEdge*> &getEdgeVector() const throw() {
        return myRoute;
    }

    const RGBColor * const getColor() const throw() {
        return myColor;
    }


    void recheckForLoops() throw();

    OutputDevice &
    writeXMLDefinition(SUMOAbstractRouter<ROEdge,ROVehicle> &router, OutputDevice &dev, const ROVehicle * const veh, bool asAlternatives, bool withExitTimes) const;


private:
    SUMOReal myCosts;

    SUMOReal myProbability;

    std::vector<const ROEdge*> myRoute;

    const RGBColor *myColor;

private:
    RORoute &operator=(const RORoute &src);

};


#endif

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