MSStageTrip.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
/****************************************************************************/
// An intermodal routing request (to be transformed into a sequence of walks and rides)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <microsim/transportables/MSStage.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSTransportable;
class MSEdge;
class MSLane;
class MSNet;
class MSStoppingPlace;
class OutputDevice;
 
class MSStageTrip : public MSStage {
public:
    MSStageTrip(const MSEdge* origin, MSStoppingPlace* fromStop,
                const MSEdge* destination, MSStoppingPlace* toStop,
                const SUMOTime duration, const SVCPermissions modeSet,
                const std::string& vTypes, const double speed, const double walkFactor,
                const std::string& group,
                const double departPosLat, const bool hasArrivalPos, const double arrivalPos);
 
    virtual ~MSStageTrip();
 
    MSStage* clone() const;
 
    const MSEdge* getEdge() const;
 
    MSStoppingPlace* getOriginStop() const {
        return myOriginStop;
    }
 
    double getEdgePos(SUMOTime now) const;
 
    Position getPosition(SUMOTime now) const;
 
    double getAngle(SUMOTime now) const;
 
    double getDistance() const {
        // invalid
        return -1;
    }
 
    std::string getStageDescription(const bool isPerson) const {
        UNUSED_PARAMETER(isPerson);
        return "trip";
    }
 
    std::string getOriginDescription() const;
    std::string getDestinationDescription() const;
 
    std::string getStageSummary(const bool isPerson) const;
 
    std::vector<SUMOVehicle*> getVehicles(MSVehicleControl& vehControl, MSTransportable* transportable, const MSEdge* origin);
 
    const std::string reroute(const SUMOTime time, MSTransportableRouter& router, MSTransportable* const transportable,
                              MSStage* previous, const MSEdge* origin, const MSEdge* destination, std::vector<MSStage*>& stages);
 
    const std::string setArrived(MSNet* net, MSTransportable* transportable, SUMOTime now, const bool vehicleArrived);
 
    void setOrigin(const MSEdge* origin, MSStoppingPlace* originStop, double departPos) {
        myOrigin = origin;
        myOriginStop = originStop;
        myDepartPos = departPos;
    }
 
    void proceed(MSNet* net, MSTransportable* transportable, SUMOTime now, MSStage* previous);
 
    void tripInfoOutput(OutputDevice& os, const MSTransportable* const transportable) const {
        UNUSED_PARAMETER(os);
        UNUSED_PARAMETER(transportable);
    }
 
    SUMOTime getDuration() const {
        return 0;
    }
 
    SUMOTime getTravelTime() const {
        return 0;
    }
 
    void routeOutput(const bool isPerson, OutputDevice& os, const bool withRouteLength, const MSStage* const previous) const;
 
    bool isWalk() const {
        return myModeSet == 0;
    }
 
private:
    const MSEdge* myOrigin;
 
    MSStoppingPlace* myOriginStop;
 
    SUMOTime myDuration;
 
    const SVCPermissions myModeSet;
 
    const std::string myVTypes;
 
    const double mySpeed;
 
    const double myWalkFactor;
 
    double myDepartPos;
 
    const double myDepartPosLat;
 
    const bool myHaveArrivalPos;
 
private:
    MSStageTrip(const MSStageTrip&);
 
    MSStageTrip& operator=(const MSStageTrip&);
 
};