RORoute.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A complete router's route
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <utils/common/Named.h>
#include <utils/common/RGBColor.h>
#include <utils/router/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(const ConstROEdgeVector& mandatory);
 
 
    bool isValid(const ROVehicle& veh, bool ignoreErrors) const;
 
    OutputDevice&
    writeXMLDefinition(OutputDevice& dev, const ROVehicle* const veh,
                       const bool withCosts, const bool withProb,
                       const bool withExitTimes, const bool withLength,
                       const std::string& id = "") 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;
            }
        }
    }
 
    ConstROEdgeVector getNormalEdges() const;
 
private:
    double myCosts;
 
    double myProbability;
 
    ConstROEdgeVector myRoute;
 
    const RGBColor* myColor;
 
    std::vector<SUMOVehicleParameter::Stop> myStops;
 
 
private:
    RORoute& operator=(const RORoute& src);
 
};