MEVehicle.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
/****************************************************************************/
// A vehicle from the mesoscopic point of view
/****************************************************************************/
#ifndef MEVehicle_h
#define MEVehicle_h


// ===========================================================================
// included modules
// ===========================================================================
#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, const MSRoute* route,
              MSVehicleType* type, const double speedFactor);


    double getPositionOnLane() const;


    double getBackPositionOnLane(const MSLane* lane) const;


    double getAngle() const;


    double getSlope() const;

    MSLane* getLane() const {
        return 0;
    }

    Position getPosition(const double offset = 0) const;


    double getSpeed() const;

    double getAverageSpeed() const;

    double estimateLeaveSpeed(const MSLink* link) const;


    double getConservativeSpeed(SUMOTime& earliestArrival) const;


    bool moveRoutePointer();

    bool hasArrived() const;

    bool isOnRoad() const;

    bool isParking() const;

    bool addStop(const SUMOVehicleParameter::Stop& stopPar, std::string& errorMsg, SUMOTime untilOffset = 0, bool collision = false,
                 MSRouteIterator* searchStart = 0);


    bool isStopped() const;

    SUMOTime remainingStopDuration() const {
        return 0;
    }

    void processStop();

    bool isStoppedTriggered() const;

    bool isStoppedInRange(double pos) const;

    SUMOTime getStoptime(const MESegment* const seg, SUMOTime time) const;


    const ConstMSEdgeVector getStopEdges() const;

    bool replaceParkingArea(MSParkingArea* /* parkingArea = 0 */, std::string& /*errorMsg*/) {
        throw ProcessError("parkingZoneReroute not implemented for meso");
    }

    MSParkingArea* getNextParkingArea() {
        throw ProcessError("parkingZoneReroute not implemented for meso");
    }

    inline void setEventTime(SUMOTime t, bool hasDelay = true) {
        assert(t > myLastEntryTime);
        if (hasDelay && mySegment != 0) {
            mySegment->getEdge().markDelayed();
        }
        myEventTime = t;
    }


    inline SUMOTime getEventTime() const {
        return myEventTime;
    }


    inline virtual void setSegment(MESegment* s, int idx = 0) {
        mySegment = s;
        myQueIndex = idx;
    }


    inline MESegment* getSegment() const {
        return mySegment;
    }


    inline int getQueIndex() const {
        return myQueIndex;
    }


    inline void setLastEntryTime(SUMOTime t) {
        myLastEntryTime = t;
    }


    SUMOTime getLastEntryTime() const {
        return myLastEntryTime;
    }


    inline void setBlockTime(const SUMOTime t) {
        assert(t > myLastEntryTime);
        myBlockTime = t;
    }


    inline SUMOTime getBlockTime() const {
        return myBlockTime;
    }


    inline SUMOTime getWaitingTime() const {
        return MAX2(SUMOTime(0), myEventTime - myBlockTime);
    }

    inline SUMOTime getAccumulatedWaitingTime() const {
        return getWaitingTime();
    }


    double getWaitingSeconds() const {
        return STEPS2TIME(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(const MSRoute* route,  const std::string& info, bool onInit = false, int offset = 0, bool addStops = true, bool removeStops = true);

    bool mayProceed() const;

    void updateDetectorForWriting(MSMoveReminder* rem, SUMOTime currentTime, SUMOTime exitTime);

    void updateDetectors(SUMOTime currentTime, const bool isLeave,
                         const MSMoveReminder::Notification reason = MSMoveReminder::NOTIFICATION_JUNCTION);



    void saveState(OutputDevice& out);

    void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset);


protected:
    MESegment* mySegment;

    int myQueIndex;

    SUMOTime myEventTime;

    SUMOTime myLastEntryTime;

    SUMOTime myBlockTime;

    std::map<const MESegment* const, std::vector<SUMOVehicleParameter::Stop> > myStops;

    ConstMSEdgeVector myStopEdges;

};

#endif

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