MEVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// A vehicle from the mesoscopic point of view
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MEVehicle_h
#define MEVehicle_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#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;


    bool isStoppedTriggered() const;

    bool isStoppedInRange(double pos) const;

    SUMOTime getStoptime(const MESegment* const seg) 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);
    }


    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;


    bool replaceRoute(const MSRoute* route, bool onInit = false, int offset = 0, bool addStops = 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, SUMOTime> myStops;

};

#endif

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