SUMOVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// Abstract base class for vehicle representations
/****************************************************************************/
#ifndef SUMOVehicle_h
#define SUMOVehicle_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <vector>
#include <typeinfo>
#include <utils/common/SUMOTime.h>
#include <utils/common/Named.h>
#include <utils/vehicle/SUMOAbstractRouter.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/iodevices/OutputDevice.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSVehicleType;
class MSRoute;
class MSEdge;
class MSLane;
class MSDevice;
class MSPerson;
class MSTransportable;
class MSParkingArea;
class SUMOSAXAttributes;

typedef std::vector<const MSEdge*> ConstMSEdgeVector;


// ===========================================================================
// class definitions
// ===========================================================================
class SUMOVehicle {
public:

    // XXX: This definition was introduced to make the MSVehicle's previousSpeed
    //      available in the context of MSMoveReminder::notifyMove(). Another solution
    //      would be to modify notifyMove()'s interface to work with MSVehicle instead
    //      of SUMOVehicle (it is only called with MSVehicles!). Refs. #2579
    virtual double getPreviousSpeed() const = 0;

    virtual ~SUMOVehicle() {}

    virtual const std::string& getID() const = 0;

    virtual double getPositionOnLane() const = 0;

    virtual double getBackPositionOnLane(const MSLane* lane) const = 0;

    virtual double getLateralPositionOnLane() const = 0;

    virtual double getAngle() const = 0;

    virtual Position getPosition(const double offset = 0) const = 0;

    virtual double getMaxSpeed() const = 0;

    virtual double getSpeed() const = 0;

    virtual MSLane* getLane() const = 0;

    virtual const MSVehicleType& getVehicleType() const = 0;

    virtual SUMOVehicleClass getVClass() const = 0;

    virtual const MSRoute& getRoute() const = 0;

    virtual const MSEdge* succEdge(int nSuccs) const = 0;

    virtual bool replaceRouteEdges(ConstMSEdgeVector& edges, const std::string& info, bool onInit = false, bool check = false, bool removeStops = true) = 0;

    virtual bool replaceRoute(const MSRoute* route, const std::string& info, bool onInit = false, int offset = 0, bool addStops = true, bool removeStops = true) = 0;

    virtual void reroute(SUMOTime t, const std::string& info, SUMOAbstractRouter<MSEdge, SUMOVehicle>& router, const bool onInit = false, const bool withTaz = false) = 0;

    virtual bool hasValidRoute(std::string& msg, const MSRoute* route = 0) const = 0;


    virtual const ConstMSEdgeVector::const_iterator& getCurrentRouteEdge() const = 0;

    virtual double getAcceleration() const = 0;

    virtual double getSlope() const = 0;

    virtual const MSEdge* getEdge() const = 0;

    virtual const SUMOVehicleParameter& getParameter() const = 0;

    virtual void replaceParameter(const SUMOVehicleParameter* newParameter) = 0;

    virtual void onDepart() = 0;

    virtual bool isOnRoad() 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 bool hasArrived() const = 0;

    virtual int getNumberReroutes() const = 0;

    virtual const std::vector<MSDevice*>& getDevices() const = 0;

    virtual void addPerson(MSTransportable* person) = 0;

    virtual void addContainer(MSTransportable* container) = 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, bool collision = false,
                         ConstMSEdgeVector::const_iterator* searchStart = 0) = 0;


    virtual MSParkingArea* getNextParkingArea() = 0;

    virtual bool replaceParkingArea(MSParkingArea* parkingArea, std::string& errorMsg) = 0;

    virtual bool isStopped() const = 0;

    virtual SUMOTime remainingStopDuration() const = 0;

    virtual bool isStoppedTriggered() const = 0;

    virtual bool isStoppedInRange(double pos) const = 0;

    virtual MSDevice* getDevice(const std::type_info& type) const = 0;


    virtual double getChosenSpeedFactor() const = 0;

    virtual void setChosenSpeedFactor(const double factor) = 0;

    virtual SUMOTime getWaitingTime() const = 0;

    virtual SUMOTime getAccumulatedWaitingTime() const = 0;

    virtual SUMOTime getDepartDelay() const = 0;

    virtual double getImpatience() const = 0;

    virtual bool isSelected() const = 0;



    virtual void saveState(OutputDevice& out) = 0;

    virtual void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset) = 0;
};


#endif

/****************************************************************************/