ROLane.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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 single lane the router may use
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <utils/geom/PositionVector.h>
#include <utils/common/Named.h>
#include <utils/common/SUMOVehicleClass.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class ROLane : public Named {
public:
    ROLane(const std::string& id, ROEdge* edge, double length, double maxSpeed, SVCPermissions permissions, const PositionVector& shape) :
        Named(id), myEdge(edge), myLength(length), myMaxSpeed(maxSpeed), myPermissions(permissions), myShape(shape),
        myLengthGeometryFactor(MAX2(NUMERICAL_EPS, myShape.length() / myLength)) // factor should not be 0
    { }
 
 
    ~ROLane() { }
 
 
    double getLength() const {
        return myLength;
    }
 
 
    double getSpeed() const {
        return myMaxSpeed;
    }
 
 
    inline SVCPermissions getPermissions() const {
        return myPermissions;
    }
 
    void  setPermissions(SVCPermissions permissions) {
        myPermissions = permissions;
    }
 
    ROEdge& getEdge() const {
        return *myEdge;
    }
 
    const std::vector<std::pair<const ROLane*, const ROEdge*> >& getOutgoingViaLanes() const {
        return myOutgoingLanes;
    }
 
    void addOutgoingLane(ROLane* lane, ROEdge* via = nullptr) {
        myOutgoingLanes.push_back(std::make_pair(lane, via));
    }
 
    inline LinkState getIncomingLinkState() const {
        return LINKSTATE_MAJOR;
    }
 
    inline bool allowsVehicleClass(SUMOVehicleClass vclass) const {
        return (myPermissions & vclass) == vclass;
    }
 
    const PositionVector& getShape() const {
        return myShape;
    }
 
    /* @brief fit the given lane position to a visibly suitable geometry position
     * (lane length might differ from geometry length) */
    inline double interpolateLanePosToGeometryPos(double lanePos) const {
        return lanePos * myLengthGeometryFactor;
    }
 
    /* @brief fit the given lane position to a visibly suitable geometry position
     * and return the coordinates */
    inline const Position geometryPositionAtOffset(double offset, double lateralOffset = 0) const {
        return myShape.positionAtOffset(interpolateLanePosToGeometryPos(offset), lateralOffset);
    }
 
private:
    ROEdge* myEdge;
 
    double myLength;
 
    double myMaxSpeed;
 
    SVCPermissions myPermissions;
 
    std::vector<std::pair<const ROLane*, const ROEdge*> > myOutgoingLanes;
 
    const PositionVector myShape;
 
    const double myLengthGeometryFactor;
 
 
private:
    ROLane(const ROLane& src);
 
    ROLane& operator=(const ROLane& src);
 
};