MSStageMoving.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// The common superclass for modelling walking and tranship
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <microsim/transportables/MSStage.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================

class MSStageMoving : public MSStage {
public:
    MSStageMoving(const MSStageType type, const std::vector<const MSEdge*>& route, const std::string& routeID, MSStoppingPlace* toStop, const double speed,
                  const double departPos, const double arrivalPos, const double departPosLat, const int departLane) :
        MSStage(type, route.back(), toStop, arrivalPos),
        myPState(nullptr), myRoute(route), myRouteID(routeID), myRouteStep(myRoute.begin()),
        mySpeed(speed), myDepartPos(departPos),
        myDepartPosLat(departPosLat), myDepartLane(departLane) {}

    virtual ~MSStageMoving();
 
    virtual const MSEdge* getNextRouteEdge() const = 0;
 
    inline MSTransportableStateAdapter* getPState() const {
        return myPState;
    }
 
    inline void setPState(MSTransportableStateAdapter* pstate) {
        myPState = pstate;
    }

    const MSEdge* getEdge() const;

    const MSLane* getLane() const;

    const MSEdge* getFromEdge() const;

    ConstMSEdgeVector getEdges() const;

    double getEdgePos(SUMOTime now) const;

    int getDirection() const;

    Position getPosition(SUMOTime now) const;

    double getAngle(SUMOTime now) const;

    SUMOTime getWaitingTime() const;

    SUMOTime getTotalWaitingTime() const;

    double getSpeed() const;

    double getConfiguredSpeed() const {
        return mySpeed;
    }

    virtual double getMaxSpeed(const MSTransportable* const transportable = nullptr) const = 0;

    virtual bool moveToNextEdge(MSTransportable* transportable, SUMOTime currentTime, int prevDir, MSEdge* nextInternal = nullptr, const bool isReplay = false) = 0;

    virtual void activateEntryReminders(MSTransportable* person, const bool isDepart = false) {
        UNUSED_PARAMETER(person);
        UNUSED_PARAMETER(isDepart);
    }

    virtual void setRouteIndex(MSTransportable* const transportable, int routeOffset);
 
    virtual void replaceRoute(MSTransportable* const transportable, const ConstMSEdgeVector& edges, int routeOffset);
 
    inline const std::vector<const MSEdge*>& getRoute() const {
        return myRoute;
    }
 
    inline const std::vector<const MSEdge*>::iterator getRouteStep() const {
        return myRouteStep;
    }
 
    inline double getDepartPos() const {
        return myDepartPos;
    }
 
    inline void setDepartPos(const double pos) {
        myDepartPos = pos;
    }
 
    inline double getDepartPosLat() const {
        return myDepartPosLat;
    }
 
    inline int getDepartLane() const {
        return myDepartLane;
    }

    static const MSLane* checkDepartLane(const MSEdge* edge, SUMOVehicleClass svc, int laneIndex, const std::string& id);
 
    bool equals(const MSStage& s) const {
        if (!MSStage::equals(s)) {
            return false;
        }
        // this is safe because MSStage already checked that the type fits
        const MSStageMoving& sm = static_cast<const MSStageMoving&>(s);
        return myRoute == sm.myRoute &&
               myRouteID == sm.myRouteID &&
               mySpeed == sm.mySpeed &&
               myDepartPos == sm.myDepartPos &&
               myDepartPosLat == sm.myDepartPosLat &&
               myDepartLane == sm.myDepartLane;
    }
 
protected:
    MSTransportableStateAdapter* myPState;

    std::vector<const MSEdge*> myRoute;

    std::string myRouteID;

    std::vector<const MSEdge*>::iterator myRouteStep;

    MSEdge* myCurrentInternalEdge = nullptr;

    double mySpeed;

    double myDepartPos;

    double myDepartPosLat;

    int myDepartLane;
};