RORoutable.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-2025 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 routable thing such as a vehicle or person
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <iostream>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/RandHelper.h>
#include <utils/router/RouterProvider.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/vehicle/SUMOVTypeParameter.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class ROEdge;
class ROLane;
class RONode;
class ROVehicle;
 
typedef std::vector<const ROEdge*> ConstROEdgeVector;
typedef IntermodalRouter<ROEdge, ROLane, RONode, ROVehicle> ROIntermodalRouter;
typedef RouterProvider<ROEdge, ROLane, RONode, ROVehicle> RORouterProvider;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class RORoutable {
public:
    RORoutable(const SUMOVehicleParameter& pars, const SUMOVTypeParameter* type) :
        myParameter(pars),
        myType(type),
        myRandomSeed(RandHelper::murmur3_32(pars.id, RandHelper::getSeed())),
        myRoutingSuccess(false) {}
 
 
    virtual ~RORoutable() {}
 
 
    inline const SUMOVehicleParameter& getParameter() const {
        return myParameter;
    }
 
 
    inline const SUMOVTypeParameter* getType() const {
        return myType;
    }
 
 
    inline const std::string& getID() const {
        return myParameter.id;
    }
 
    long long int getRandomSeed() const {
        return myRandomSeed;
    }
 
    inline double getChosenSpeedFactor() const {
        return getParameter().wasSet(VEHPARS_SPEEDFACTOR_SET) ? getParameter().speedFactor :  getType()->speedFactor.getParameter(0);
    }
 
    inline SUMOTime getDepart() const {
        return myParameter.depart;
    }
 
    inline void setDepart(SUMOTime t) {
        myParameter.depart = t;
    }
 
    inline SUMOVehicleClass getVClass() const {
        return getType() != 0 ? getType()->vehicleClass : SVC_IGNORING;
    }
 
    bool ignoreTransientPermissions() const {
        return false;
    };
 
    inline double getMaxSpeed() const {
        return MIN2(getType()->maxSpeed,
                    getType()->desiredMaxSpeed * getChosenSpeedFactor());
    }
 
    virtual const ROEdge* getDepartEdge() const = 0;
 
 
    inline bool isPublicTransport() const {
        return myParameter.line != "";
    }
 
    inline bool isPartOfFlow() const {
        return myParameter.repetitionNumber >= 0;
    }
 
    virtual void computeRoute(const RORouterProvider& provider,
                              const bool removeLoops, MsgHandler* errorHandler) = 0;
 
 
    void write(OutputDevice* os, OutputDevice* const altos,
               OutputDevice* const typeos, OptionsCont& options, int quota) const {
        for (int i = 0; i < quota; i++) {
            if (os != nullptr) {
                if (altos == nullptr && typeos == nullptr) {
                    saveAsXML(*os, os, false, options, i);
                } else {
                    saveAsXML(*os, typeos, false, options, i);
                }
            }
            if (altos != nullptr) {
                saveAsXML(*altos, typeos, true, options, i);
            }
        }
    }
 
 
    inline bool getRoutingSuccess() const {
        return myRoutingSuccess;
    }
 
 
protected:
    virtual void saveAsXML(OutputDevice& os, OutputDevice* const typeos, bool asAlternatives, OptionsCont& options, int cloneIndex = 0) const = 0;
 
 
private:
    SUMOVehicleParameter myParameter;
 
    const SUMOVTypeParameter* const myType;
 
    const long long int myRandomSeed;
 
protected:
    bool myRoutingSuccess;
 
 
private:
    RORoutable(const RORoutable& src);
 
    RORoutable& operator=(const RORoutable& src);
 
};