MSDevice_Transportable.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 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 device which is used to keep track of persons and containers riding with a vehicle
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include "MSVehicleDevice.h"
#include <utils/common/SUMOTime.h>
#include <microsim/MSVehicle.h>
#include <utils/common/WrappingCommand.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Transportable : public MSVehicleDevice {
public:
    static MSDevice_Transportable* buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into, const bool isContainer);
 
 
public:
    ~MSDevice_Transportable();
 
 
 
    bool notifyMove(SUMOTrafficObject& veh, double oldPos, double newPos, double newSpeed);
 
 
    bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    bool notifyLeave(SUMOTrafficObject& veh, double lastPos,
                     MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    const std::string deviceName() const {
        return myAmContainer ? "container" : "person";
    }
 
    std::string getParameter(const std::string& key) const;
 
    void addTransportable(MSTransportable* transportable);
 
    void removeTransportable(MSTransportable* transportable);
 
 
    bool anyLeavingAtStop(const MSStop& stop) const;
 
    void transferAtSplitOrJoin(MSBaseVehicle* otherVeh);
 
    void saveState(OutputDevice& out) const;
 
    void loadState(const SUMOSAXAttributes& attrs);
 
    int size() const {
        return (int)myTransportables.size();
    }
 
 
    const std::vector<MSTransportable*>& getTransportables() const {
        return myTransportables;
    }
 
    std::vector<Position>& getUnboardingPositions() {
        return myUnboardingPositions;
    }
 
    static bool willTransferAtJoin(const MSTransportable* t, const MSBaseVehicle* joinVeh);
 
protected:
    void notifyMoveInternal(const SUMOTrafficObject& veh,
                            const double frontOnLane,
                            const double timeOnLane,
                            const double meanSpeedFrontOnLane,
                            const double meanSpeedVehicleOnLane,
                            const double travelledDistanceFrontOnLane,
                            const double travelledDistanceVehicleOnLane,
                            const double meanLengthOnLane);
 
private:
    MSDevice_Transportable(SUMOVehicle& holder, const std::string& id, const bool isContainer);
 
 
private:
    const bool myAmContainer;
 
    std::vector<MSTransportable*> myTransportables;
 
    /* @brief Whether the vehicle is at a stop and the stop is finished
     * true means, all passengers that wish to debord at the current stop have left
     */
    bool myStopped;
 
    std::vector<Position> myUnboardingPositions;
 
 
private:
    MSDevice_Transportable(const MSDevice_Transportable&);
 
    MSDevice_Transportable& operator=(const MSDevice_Transportable&);
 
 
};