MSStageWaiting.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 stage for planned waiting (stopping)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <microsim/transportables/MSStage.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSEdge;
class MSLane;
class MSNet;
class MSStoppingPlace;
class MSVehicleType;
class OutputDevice;
class MSTransportable;
 

class MSStageWaiting : public MSStage {
public:
    MSStageWaiting(const MSEdge* destination, MSStoppingPlace* toStop, SUMOTime duration, SUMOTime until,
                   double pos, const std::string& actType, const bool initial, SUMOTime jumpDuration = -1);

    virtual ~MSStageWaiting();
 
    MSStage* clone() const;

    void abort(MSTransportable*);
 
    SUMOTime getUntil() const;
 
    SUMOTime getPlannedDuration() const;
 
    SUMOTime getJumpDuration() const {
        return myJumpDuration;
    }
 
    SUMOTime getTravelTime() const {
        // not a travelling stage
        return 0;
    }
 
    SUMOTime getDuration() const;
 
    SUMOTime getStopEnd() const {
        return myStopEndTime;
    }

    Position getPosition(SUMOTime now) const;
 
    double getAngle(SUMOTime now) const;

    double getDistance() const {
        return 0;
    }
 
    std::string getStageDescription(const bool isPerson) const;
 
    std::string getStageSummary(const bool isPerson) const;

    void proceed(MSNet* net, MSTransportable* transportable, SUMOTime now, MSStage* previous);

    void tripInfoOutput(OutputDevice& os, const MSTransportable* const transportable) const;

    void routeOutput(const bool isPerson, OutputDevice& os, const bool withRouteLength, const MSStage* const previous) const;
 
    void saveState(std::ostringstream& out);
 
    void loadState(MSTransportable* transportable, std::istringstream& state);
 
private:
    SUMOTime myWaitingDuration;

    SUMOTime myWaitingUntil;

    Position myStopWaitPos;

    std::string myActType;

    SUMOTime myJumpDuration;

    SUMOTime myStopEndTime;
 
private:
    MSStageWaiting(const MSStageWaiting&);

    MSStageWaiting& operator=(const MSStageWaiting&) = delete;
 
};