MEVehicle.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 vehicle from the mesoscopic point of view
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <iostream>
#include <cassert>
#include <map>
#include <vector>
#include <microsim/MSBaseVehicle.h>
#include <microsim/MSEdge.h>
#include <utils/common/StdDefs.h>
#include "MESegment.h"
 
class MSLane;
class MSLink;
 
// ===========================================================================
// class definitions
// ===========================================================================
class MEVehicle : public MSBaseVehicle {
public:
    MEVehicle(SUMOVehicleParameter* pars, ConstMSRoutePtr route,
              MSVehicleType* type, const double speedFactor);
 
 
    double getPositionOnLane() const;
 
 
    double getBackPositionOnLane(const MSLane* lane) const;
 
 
    double getAngle() const;
 
 
    double getSlope() const;
 
    const MSEdge* getCurrentEdge() const;
 
    const MSLane* getLane() const {
        return nullptr;
    }
 
    const MSLane* getBackLane() const {
        return nullptr;
    }
 
    Position getPosition(const double offset = 0) const;
 
    PositionVector getBoundingBox(double offset = 0) const;
 
    double getSpeed() const;
 
    double getAverageSpeed() const;
 
    double estimateLeaveSpeed(const MSLink* link) const;
 
 
    double getConservativeSpeed(SUMOTime& earliestArrival) const;
 
 
 
    void onRemovalFromNet(const MSMoveReminder::Notification reason);
 
 
    bool moveRoutePointer();
 
    bool hasArrived() const;
 
    bool isOnRoad() const;
 
    virtual bool isIdling() const;
 
 
    void setApproaching(MSLink* link);
 
    SUMOTime remainingStopDuration() const {
        return 0;
    }
 
    bool instantStopping() const {
        return true;
    }
 
    void processStop();
 
    SUMOTime checkStop(SUMOTime time);
 
    bool resumeFromStopping();
 
    double getBrakeGap(bool delayed = false) const {
        UNUSED_PARAMETER(delayed);
        return mySegment == nullptr || myQueIndex == MESegment::PARKING_QUEUE ? 0 : mySegment->getLength();
    }
 
    inline void setEventTime(SUMOTime t, bool hasDelay = true) {
        assert(t > myLastEntryTime);
        if (hasDelay && mySegment != nullptr) {
            mySegment->getEdge().markDelayed();
        }
        myEventTime = t;
    }
 
 
    inline SUMOTime getEventTime() const {
        return myEventTime;
    }
 
    inline void setUnqueuedEventTime(SUMOTime t) {
        myUnqueuedEventTime = t;
    }
    inline SUMOTime getUnqueuedEventTime() const {
        return myUnqueuedEventTime;
    }
 
 
    inline virtual void setSegment(MESegment* s, int idx = 0) {
        mySegment = s;
        myQueIndex = idx;
    }
 
 
    inline MESegment* getSegment() const {
        return mySegment;
    }
 
    int getSegmentIndex() const;
 
    inline int getQueIndex() const {
        return myQueIndex;
    }
 
    double getRightSideOnEdge(const MSLane* /*lane*/) const;
 
    inline void setLastEntryTime(SUMOTime t) {
        myLastEntryTime = t;
    }
 
 
    SUMOTime getLastEntryTime() const {
        return myLastEntryTime;
    }
 
    SUMOTime getLastActionTime() const {
        return SIMSTEP;
    }
 
    inline void setBlockTime(const SUMOTime t) {
        assert(t > myLastEntryTime);
        myBlockTime = t;
    }
 
 
    inline SUMOTime getBlockTime() const {
        return myBlockTime;
    }
 
 
    inline SUMOTime getWaitingTime(const bool accumulated = false) const {
        UNUSED_PARAMETER(accumulated);
        return MAX2(SUMOTime(0), myEventTime - myBlockTime);
    }
 
    inline SUMOTime getQueuingTimeLoss() const {
        return MAX2(SUMOTime(0), myEventTime - myUnqueuedEventTime);
    }
 
    inline SUMOTime getTimeLoss() const {
        // slow-downs while driving are not modelled
        return getWaitingTime();
    }
 
    double getEventTimeSeconds() const {
        return STEPS2TIME(getEventTime());
    }
 
    double getLastEntryTimeSeconds() const {
        return STEPS2TIME(getLastEntryTime());
    }
 
    double getBlockTimeSeconds() const {
        return STEPS2TIME(getBlockTime());
    }
 
    double getCurrentLinkPenaltySeconds() const;
 
    double getCurrentStoppingTimeSeconds() const;
 
    bool replaceRoute(ConstMSRoutePtr route,  const std::string& info, bool onInit = false, int offset = 0, bool addRouteStops = true, bool removeStops = true, std::string* msgReturn = nullptr);
 
    bool mayProceed();
 
    void updateDetectorForWriting(MSMoveReminder* rem, SUMOTime currentTime, SUMOTime exitTime);
 
    void updateDetectors(const SUMOTime currentTime, const SUMOTime exitTime, const bool isLeave,
                         const MSMoveReminder::Notification reason = MSMoveReminder::NOTIFICATION_JUNCTION);
 
    BaseInfluencer& getBaseInfluencer();
 
    const BaseInfluencer* getBaseInfluencer() const;
 
    bool hasInfluencer() const {
        return myInfluencer != nullptr;
    }
 
    void markJammed(bool jammed) {
        myWasJammed = jammed;
    }
 
    bool wasJammed() const {
        return myWasJammed;
    }
 
 
 
    void saveState(OutputDevice& out);
 
    void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset);
 
 
protected:
    MESegment* mySegment;
 
    int myQueIndex;
 
    SUMOTime myEventTime;
 
    SUMOTime myLastEntryTime;
 
    SUMOTime myBlockTime;
 
    SUMOTime myUnqueuedEventTime;
 
    bool myWasJammed;
 
    BaseInfluencer* myInfluencer;
 
};