RORoute.h

Go to the documentation of this file.

/****************************************************************************/
// A complete router's route
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
// Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO 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 3 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>
#include <utils/common/SUMOVehicleParameter.h>


// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;
class ROVehicle;
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,
            const std::vector<SUMOVehicleParameter::Stop>& stops);


    RORoute(const RORoute& src);


    ~RORoute();


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


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


    SUMOReal getCosts() const {
        return myCosts;
    }


    SUMOReal getProbability() const {
        return myProbability;
    }


    void setCosts(SUMOReal costs);


    void setProbability(SUMOReal prob);


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


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

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


    void recheckForLoops();

    OutputDevice&
    writeXMLDefinition(OutputDevice& dev, const ROVehicle* const veh,
                       const bool withCosts, const bool withExitTimes) const;

    void addProbability(SUMOReal prob);

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

private:
    SUMOReal myCosts;

    SUMOReal myProbability;

    std::vector<const ROEdge*> myRoute;

    const RGBColor* myColor;

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


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

};


#endif

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