ROVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-2026 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 vehicle as used by router
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <iostream>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOTime.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/vehicle/SUMOVTypeParameter.h>
#include "RORoutable.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class ROEdge;
class RONet;
class RORouteDef;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class ROVehicle : public RORoutable {
public:
    ROVehicle(const SUMOVehicleParameter& pars,
              RORouteDef* route, const SUMOVTypeParameter* type,
              const RONet* net, MsgHandler* errorHandler = 0);
 
 
    virtual ~ROVehicle();
 
 
    inline RORouteDef* getRouteDefinition() const {
        return myRoute;
    }
 
 
    const ROEdge* getDepartEdge() const;
 
 
    void computeRoute(const RORouterProvider& provider,
                      const bool removeLoops, MsgHandler* errorHandler);
 
    inline SUMOTime getDepartureTime() const {
        return MAX2(SUMOTime(0), getParameter().depart);
    }
 
 
    struct Mandatory {
        Mandatory(const ROEdge* e, double p, SUMOTime jump = -1):
            edge(e),
            pos(p),
            isJump(jump >= 0) {}
 
        const ROEdge* edge;
        double pos;
        bool isJump;
    };
 
    std::vector<Mandatory> getMandatoryEdges(const ROEdge* requiredStart, const ROEdge* requiredEnd) const;
 
    inline const SUMOVTypeParameter& getVTypeParameter() const  {
        return *getType();
    }
 
    inline double getLength() const {
        return getType()->length;
    }
 
    inline bool hasJumps() const {
        return myJumpTime >= 0;
    }
 
    inline SUMOTime getJumpTime() const {
        return myJumpTime;
    }
 
    void saveAsXML(OutputDevice& os, OutputDevice* const typeos, bool asAlternatives, OptionsCont& options, int cloneIndex = 0) const;
 
 
private:
    void addStop(const SUMOVehicleParameter::Stop& stopPar,
                 const RONet* net, MsgHandler* errorHandler);
 
private:
    RORouteDef* const myRoute;
 
    SUMOTime myJumpTime;
 
    static std::map<ConstROEdgeVector, std::string> mySavedRoutes;
 
private:
    ROVehicle(const ROVehicle& src);
 
    ROVehicle& operator=(const ROVehicle& src);
 
};