MSPerson.h

Go to the documentation of this file.

/****************************************************************************/
// The class for modelling person-movements
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2015 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 MSPerson_h
#define MSPerson_h


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

#include <string>
#include <vector>
#include <set>
#include <utils/common/SUMOTime.h>
#include <utils/common/Command.h>
#include <utils/geom/Position.h>
#include <utils/geom/PositionVector.h>
#include <microsim/MSTransportable.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSNet;
class MSEdge;
class MSLane;
class OutputDevice;
class SUMOVehicleParameter;
class MSStoppingPlace;
class SUMOVehicle;
class MSVehicleType;
class MSPModel;
class PedestrianState;

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

// ===========================================================================
// class definitions
// ===========================================================================
class MSPerson : public MSTransportable {
public:
    class MSPersonStage_Walking : public MSTransportable::Stage {
        friend class MSPModel;
        friend class GUIPerson; // debugging

    public:
        MSPersonStage_Walking(const ConstMSEdgeVector& route, MSStoppingPlace* toBS, SUMOTime walkingTime, SUMOReal speed, SUMOReal departPos, SUMOReal arrivalPos);

        ~MSPersonStage_Walking();

        virtual void proceed(MSNet* net, MSTransportable* person, SUMOTime now, MSEdge* previousEdge, const SUMOReal at);

        const MSEdge* getEdge() const;
        const MSEdge* getFromEdge() const;
        SUMOReal getEdgePos(SUMOTime now) const;

        Position getPosition(SUMOTime now) const;

        SUMOReal getAngle(SUMOTime now) const;

        SUMOTime getWaitingTime(SUMOTime now) const;

        SUMOReal getSpeed() const;

        std::string getStageDescription() const {
            return "walking";
        }

        virtual void tripInfoOutput(OutputDevice& os) const;

        virtual void routeOutput(OutputDevice& os) const;

        virtual void beginEventOutput(const MSTransportable& p, SUMOTime t, OutputDevice& os) const;

        virtual void endEventOutput(const MSTransportable& p, SUMOTime t, OutputDevice& os) const;

        bool moveToNextEdge(MSPerson* person, SUMOTime currentTime, MSEdge* nextInternal = 0);



        inline SUMOReal getMaxSpeed() const {
            return mySpeed;
        }
        inline SUMOReal getDepartPos() const {
            return myDepartPos;
        }
        inline SUMOReal getArrivalPos() const {
            return myArrivalPos;
        }

        inline const MSEdge* getRouteEdge() const {
            return *myRouteStep;
        }
        inline const MSEdge* getNextRouteEdge() const {
            return myRouteStep == myRoute.end() - 1 ? 0 : *(myRouteStep + 1);
        }
        inline const ConstMSEdgeVector& getRoute() const {
            return myRoute;
        }

        PedestrianState* getPedestrianState() const {
            return myPedestrianState;
        }


    private:

        /* @brief compute average speed if the total walking duration is given
         * @note Must be callled when the previous stage changes myDepartPos from the default*/
        SUMOReal computeAverageSpeed() const;


    private:
        SUMOTime myWalkingTime;

        ConstMSEdgeVector myRoute;


        ConstMSEdgeVector::iterator myRouteStep;

        MSEdge* myCurrentInternalEdge;

        //std::vector<SUMOTime> myArrivalTimes;

        SUMOReal myDepartPos;
        SUMOReal myArrivalPos;
        MSStoppingPlace* myDestinationBusStop;
        SUMOReal mySpeed;

        PedestrianState* myPedestrianState;

        class arrival_finder {
        public:
            explicit arrival_finder(SUMOTime time) : myTime(time) {}

            bool operator()(SUMOReal t) const {
                return myTime > t;
            }

        private:
            SUMOTime myTime;
        };

    private:
        MSPersonStage_Walking(const MSPersonStage_Walking&);

        MSPersonStage_Walking& operator=(const MSPersonStage_Walking&);

    };

    class MSPersonStage_Driving : public MSTransportable::Stage {
    public:
        MSPersonStage_Driving(const MSEdge& destination, MSStoppingPlace* toBS,
                              const std::vector<std::string>& lines);

        ~MSPersonStage_Driving();

        virtual void proceed(MSNet* net, MSTransportable* person, SUMOTime now, MSEdge* previousEdge, const SUMOReal at);

        const MSEdge* getEdge() const;
        const MSEdge* getFromEdge() const;
        SUMOReal getEdgePos(SUMOTime now) const;

        Position getPosition(SUMOTime now) const;

        SUMOReal getAngle(SUMOTime now) const;

        std::string getStageDescription() const;

        bool isWaitingFor(const std::string& line) const;

        bool isWaiting4Vehicle() const;

        SUMOTime getWaitingTime(SUMOTime now) const;

        SUMOReal getSpeed() const;

        void setVehicle(SUMOVehicle* v) {
            myVehicle = v;
        }

        virtual void tripInfoOutput(OutputDevice& os) const;

        virtual void routeOutput(OutputDevice& os) const;

        virtual void beginEventOutput(const MSTransportable& p, SUMOTime t, OutputDevice& os) const;

        virtual void endEventOutput(const MSTransportable& p, SUMOTime t, OutputDevice& os) const;

    private:
        const std::set<std::string> myLines;

        SUMOVehicle* myVehicle;

        MSStoppingPlace* myDestinationBusStop;
        SUMOReal myWaitingPos;
        SUMOTime myWaitingSince;
        const MSEdge* myWaitingEdge;

    private:
        MSPersonStage_Driving(const MSPersonStage_Driving&);

        MSPersonStage_Driving& operator=(const MSPersonStage_Driving&);

    };

    class MSPersonStage_Waiting : public MSTransportable::Stage {
    public:
        MSPersonStage_Waiting(const MSEdge& destination,
                              SUMOTime duration, SUMOTime until, SUMOReal pos, const std::string& actType);

        ~MSPersonStage_Waiting();

        const MSEdge* getEdge() const;
        const MSEdge* getFromEdge() const;
        SUMOReal getEdgePos(SUMOTime now) const;
        SUMOTime getUntil() const;

        Position getPosition(SUMOTime now) const;

        SUMOReal getAngle(SUMOTime now) const;

        SUMOTime getWaitingTime(SUMOTime now) const;

        SUMOReal getSpeed() const;

        std::string getStageDescription() const {
            return "waiting (" + myActType + ")";
        }

        virtual void proceed(MSNet* net, MSTransportable* person, SUMOTime now, MSEdge* previousEdge, const SUMOReal at);

        virtual void tripInfoOutput(OutputDevice& os) const;

        virtual void routeOutput(OutputDevice& os) const;

        virtual void beginEventOutput(const MSTransportable& p, SUMOTime t, OutputDevice& os) const;

        virtual void endEventOutput(const MSTransportable& p, SUMOTime t, OutputDevice& os) const;

    private:
        SUMOTime myWaitingDuration;

        SUMOTime myWaitingUntil;

        SUMOTime myWaitingStart;

        std::string myActType;

        SUMOReal myStartPos;


    private:
        MSPersonStage_Waiting(const MSPersonStage_Waiting&);

        MSPersonStage_Waiting& operator=(const MSPersonStage_Waiting&);

    };

public:
    MSPerson(const SUMOVehicleParameter* pars, const MSVehicleType* vtype, MSTransportable::MSTransportablePlan* plan);

    virtual ~MSPerson();

    /* @brief proceeds to the next step of the route,
     * @return Whether the persons plan continues  */
    bool proceed(MSNet* net, SUMOTime time);

    void routeOutput(OutputDevice& os) const;

    const std::string& getNextEdge() const;

private:
    MSPerson(const MSPerson&);

    MSPerson& operator=(const MSPerson&);

};


#endif

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