SUMOTrafficObject.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, person, and container representations
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <typeinfo>
#include <memory>
#include <utils/common/SUMOTime.h>
#include <utils/common/Named.h>
#include <utils/common/SUMOVehicleClass.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSVehicleType;
class SUMOVehicleParameter;
class SUMOVTypeParameter;
class MSEdge;
class MSLane;
class Position;
class MSDevice;
class MSRoute;
 
typedef std::shared_ptr<const MSRoute> ConstMSRoutePtr;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class SUMOTrafficObject : public Named {
public:
    typedef long long int NumericalID;
 
    SUMOTrafficObject(const std::string& id) : Named(id) {}
 
    virtual ~SUMOTrafficObject() {}
 
    virtual bool isVehicle() const {
        return false;
    }
 
    virtual bool isPerson() const {
        return false;
    }
 
    virtual bool isContainer() const {
        return false;
    }
 
    //  (especially fast comparison in maps which need vehicles as keys)
    virtual NumericalID getNumericalID() const = 0;
 
 
    virtual const MSVehicleType& getVehicleType() const = 0;
 
    virtual const SUMOVTypeParameter& getVTypeParameter() const = 0;
 
    virtual void replaceVehicleType(MSVehicleType* type) = 0;
 
 
    virtual const SUMOVehicleParameter& getParameter() const = 0;
 
    virtual SumoRNG* getRNG() const = 0;
 
    virtual int getRNGIndex() const = 0;
 
    virtual bool isStopped() const = 0;
 
    virtual const MSEdge* getEdge() const = 0;
 
    virtual const MSEdge* getNextEdgePtr() const = 0;
 
    virtual const std::set<NumericalID> getUpcomingEdgeIDs() const = 0;
 
    virtual const MSLane* getLane() const = 0;
 
    virtual const MSLane* getBackLane() const = 0;
 
 
    virtual int getRoutePosition() const = 0;
 
    virtual const MSEdge* getRerouteDestination() const = 0;
 
    virtual bool replaceRoute(ConstMSRoutePtr route, const std::string& info, bool onInit = false, int offset = 0, bool addStops = true, bool removeStops = true, std::string* msgReturn = nullptr) = 0;
 
    virtual double getSlope() const = 0;
 
    virtual double getChosenSpeedFactor() const = 0;
 
    virtual SUMOVehicleClass getVClass() const = 0;
 
    virtual bool ignoreTransientPermissions() const {
        return false;
    };
 
    virtual int getRoutingMode() const = 0;
 
    virtual double getMaxSpeed() const = 0;
 
    virtual SUMOTime getWaitingTime(const bool accumulated = false) const = 0;
 
    virtual double getSpeed() const = 0;
 
    // This definition was introduced to make the MSVehicle's previousSpeed Refs. #2579
    virtual double getPreviousSpeed() const = 0;
 
 
    virtual double getAcceleration() const = 0;
 
    virtual double getPositionOnLane() const = 0;
 
    virtual double getBackPositionOnLane(const MSLane* lane) const = 0;
 
 
    virtual Position getPosition(const double offset = 0) const = 0;
 
    virtual double getAngle() const = 0;
 
    virtual bool hasArrived() const = 0;
 
    virtual bool hasInfluencer() const = 0;
 
    virtual bool isSelected() const = 0;
 
    virtual MSDevice* getDevice(const std::type_info& type) const = 0;
 
 
    std::string getStringParam(const std::string& paramName, const bool required = false, const std::string& deflt = "") const;
 
    double getFloatParam(const std::string& paramName, const bool required = false, const double deflt = INVALID_DOUBLE) const;
 
    bool getBoolParam(const std::string& paramName, const bool required = false, const bool deflt = false) const;
 
    SUMOTime getTimeParam(const std::string& paramName, const bool required = false, const SUMOTime deflt = SUMOTime_MIN) const;
};