RORoute.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 complete router's route
/****************************************************************************/
#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/vehicle/SUMOAbstractRouter.h>
#include <utils/vehicle/SUMOVehicleParameter.h>


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

typedef std::vector<const ROEdge*> ConstROEdgeVector;

// ===========================================================================
// class definitions
// ===========================================================================
class RORoute : public Named {
public:
    RORoute(const std::string& id, double costs, double prob,
            const ConstROEdgeVector& route, const RGBColor* const color,
            const std::vector<SUMOVehicleParameter::Stop>& stops);


    RORoute(const std::string& id, const ConstROEdgeVector& route);

    RORoute(const RORoute& src);


    ~RORoute();


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


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


    double getCosts() const {
        return myCosts;
    }


    double getProbability() const {
        return myProbability;
    }


    void setCosts(double costs);


    void setProbability(double prob);


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


    const ConstROEdgeVector& 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(double prob);

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

    void addStopOffset(const SUMOTime offset) {
        for (std::vector<SUMOVehicleParameter::Stop>::iterator stop = myStops.begin(); stop != myStops.end(); ++stop) {
            if (stop->until >= 0) {
                stop->until += offset;
            }
        }
    }

private:
    double myCosts;

    double myProbability;

    ConstROEdgeVector myRoute;

    const RGBColor* myColor;

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


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

};


#endif

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