SUMOVehicle.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
/****************************************************************************/
// Abstract base class for vehicle representations
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <typeinfo>
#include <utils/common/SUMOTime.h>
#include <utils/common/Named.h>
#include <utils/router/SUMOAbstractRouter.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/vehicle/SUMOTrafficObject.h>
#include <utils/iodevices/OutputDevice.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSRoute;
class MSEdge;
class MSLane;
class MSPerson;
class MSStop;
class MSTransportable;
class MSParkingArea;
class MSChargingStation;
class MSStoppingPlace;
class MSVehicleDevice;
class SUMOSAXAttributes;
class EnergyParams;
class PositionVector;
 
typedef std::vector<const MSEdge*> ConstMSEdgeVector;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class SUMOVehicle : public SUMOTrafficObject {
public:
 
    SUMOVehicle(const std::string& id) : SUMOTrafficObject(id) {}
 
    virtual ~SUMOVehicle() {}
 
    virtual double getLateralPositionOnLane() const = 0;
 
    virtual double getAngle() const = 0;
 
    virtual const MSRoute& getRoute() const = 0;
 
    virtual ConstMSRoutePtr getRoutePtr() const = 0;
 
    virtual const MSEdge* succEdge(int nSuccs) const = 0;
 
    virtual ConstMSEdgeVector::const_iterator getRerouteOrigin() const = 0;
 
    virtual bool replaceRouteEdges(ConstMSEdgeVector& edges, double cost, double savings, const std::string& info, bool onInit = false, bool check = false, bool removeStops = true, std::string* msgReturn = nullptr) = 0;
 
    virtual bool reroute(SUMOTime t, const std::string& info, SUMOAbstractRouter<MSEdge, SUMOVehicle>& router, const bool onInit = false, const bool withTaz = false, const bool silent = false, const MSEdge* sink = nullptr) = 0;
 
    virtual bool hasValidRoute(std::string& msg, ConstMSRoutePtr route = 0) const = 0;
    virtual bool hasValidRouteStart(std::string& msg) = 0;
 
    virtual int getRouteValidity(bool update = true, bool silent = false, std::string* msgReturn = nullptr) = 0;
 
    virtual const ConstMSEdgeVector::const_iterator& getCurrentRouteEdge() const = 0;
 
    virtual EnergyParams* getEmissionParameters() const = 0;
 
    virtual void replaceParameter(const SUMOVehicleParameter* newParameter) = 0;
 
    virtual void onDepart() = 0;
 
    virtual bool isOnRoad() const = 0;
 
    virtual bool isIdling() const = 0;
 
    virtual bool isFrontOnLane(const MSLane*) const = 0;
 
    virtual bool isParking() const = 0;
 
    virtual bool isRemoteControlled() const = 0;
 
    virtual bool wasRemoteControlled(SUMOTime lookBack = DELTA_T) const = 0;
 
    virtual SUMOTime getDeparture() const = 0;
 
    virtual double getDepartPos() const = 0;
 
    virtual double getArrivalPos() const = 0;
 
    virtual void setArrivalPos(double arrivalPos) = 0;
 
    virtual bool hasDeparted() const = 0;
 
    virtual double getOdometer() const = 0;
 
    virtual int getNumberReroutes() const = 0;
 
    virtual bool allowsBoarding(const MSTransportable* t) const = 0;
 
    virtual void addTransportable(MSTransportable* transportable) = 0;
 
    virtual int getPersonNumber() const = 0;
 
    virtual std::vector<std::string> getPersonIDList() const = 0;
 
    virtual int getContainerNumber() const = 0;
 
    virtual void removeTransportable(MSTransportable* t) = 0;
 
    virtual const std::vector<MSTransportable*>& getPersons() const = 0;
 
    virtual const std::vector<MSTransportable*>& getContainers() const = 0;
 
    virtual bool addStop(const SUMOVehicleParameter::Stop& stopPar, std::string& errorMsg, SUMOTime untilOffset = 0,
                         ConstMSEdgeVector::const_iterator* searchStart = 0) = 0;
 
    virtual std::vector<std::pair<int, double> > getStopIndices() const = 0;
 
    virtual bool isLineStop(double position) const = 0;
 
    virtual bool abortNextStop(int nextStopIndex = 0) = 0;
 
 
    virtual MSParkingArea* getNextParkingArea() = 0;
 
    virtual bool replaceParkingArea(MSParkingArea* parkingArea, std::string& errorMsg) = 0;
 
    virtual SUMOTime remainingStopDuration() const = 0;
 
    virtual bool isStopped() const = 0;
    virtual bool isStoppedTriggered() const = 0;
 
    virtual bool isStoppedParking() const = 0;
 
    virtual bool isStoppedInRange(const double pos, const double tolerance, bool checkFuture = false) const = 0;
 
    virtual bool stopsAt(MSStoppingPlace* stop) const = 0;
 
    virtual bool stopsAtEdge(const MSEdge* edge) const = 0;
 
    virtual bool hasStops() const = 0;
 
    virtual const std::list<MSStop>& getStops() const = 0;
 
    virtual MSStop& getNextStop() = 0;
 
    virtual void unregisterWaiting() = 0;
 
    virtual const SUMOVehicleParameter::Stop* getNextStopParameter() const = 0;
 
    virtual bool addTraciStop(SUMOVehicleParameter::Stop stop, std::string& errorMsg) = 0;
 
    virtual void setChosenSpeedFactor(const double factor) = 0;
 
    virtual SUMOTime getDepartDelay() const = 0;
 
    virtual SUMOTime getTimeLoss() const = 0;
 
    virtual double getBrakeGap(bool delayed = false) const = 0;
 
    virtual double getImpatience() const = 0;
 
    virtual const std::vector<MSVehicleDevice*>& getDevices() const = 0;
 
    virtual double getLength() const = 0;
 
    /* @brief Return whether this vehicle must be treated like a railway vehicle
     * either due to its vClass or the vClass of it's edge */
    virtual bool isRail() const = 0;
 
    virtual SUMOTime getLastActionTime() const = 0;
 
    virtual PositionVector getBoundingBox(double offset = 0) const = 0;
 
 
    virtual void rememberBlockedParkingArea(const MSStoppingPlace* pa, bool local) = 0;
    virtual SUMOTime sawBlockedParkingArea(const MSStoppingPlace* pa, bool local) const = 0;
    virtual void rememberParkingAreaScore(const MSStoppingPlace* pa, const std::string& score) = 0;
    virtual void resetParkingAreaScores() = 0;
    virtual int getNumberParkingReroutes() const = 0;
    virtual void setNumberParkingReroutes(int value) = 0;
 
    virtual void rememberBlockedChargingStation(const MSStoppingPlace* cs, bool local) = 0;
    virtual SUMOTime sawBlockedChargingStation(const MSStoppingPlace* cs, bool local) const = 0;
    virtual void rememberChargingStationScore(const MSStoppingPlace* cs, const std::string& score) = 0;
    virtual void resetChargingStationScores() = 0;
 
 
 
    virtual void saveState(OutputDevice& out) = 0;
 
    virtual void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset) = 0;
};