MSTransportable.h

Go to the documentation of this file.

/****************************************************************************/
// The common superclass for modelling transportable objects like persons and containers
/****************************************************************************/
// 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 MSTransportable_h
#define MSTransportable_h

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

#include <set>
#include <cassert>
#include <utils/common/SUMOTime.h>
#include <utils/geom/Position.h>


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

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

// ===========================================================================
// class definitions
// ===========================================================================
class MSTransportable {
public:
    enum StageType {
        WAITING_FOR_DEPART = 0,
        WAITING = 1,
        MOVING_WITHOUT_VEHICLE = 2, // walking for persons, tranship for containers
        DRIVING = 3
    };

    class Stage {
    public:
        Stage(const MSEdge& destination, MSStoppingPlace* toStop, const SUMOReal arrivalPos, StageType type);

        virtual ~Stage();

        const MSEdge& getDestination() const;

        const MSStoppingPlace* getDestinationStop() const {
            return myDestinationStop;
        }

        SUMOReal getArrivalPos() const {
            return myArrivalPos;
        }

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

        virtual Position getPosition(SUMOTime now) const = 0;

        virtual SUMOReal getAngle(SUMOTime now) const = 0;

        StageType getStageType() const {
            return myType;
        }

        virtual std::string getStageDescription() const = 0;

        virtual void proceed(MSNet* net, MSTransportable* transportable, SUMOTime now, Stage* previous) = 0;

        virtual void abort(MSTransportable*) {};

        virtual void setSpeed(SUMOReal) {};

        void setDeparted(SUMOTime now);

        void setArrived(SUMOTime now);

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

        virtual bool isWaiting4Vehicle() const {
            return false;
        }

        virtual SUMOVehicle* getVehicle() const {
            return 0;
        }

        virtual SUMOTime getWaitingTime(SUMOTime now) const = 0;

        virtual SUMOReal getSpeed() const = 0;

        virtual ConstMSEdgeVector getEdges() const = 0;

        Position getEdgePosition(const MSEdge* e, SUMOReal at, SUMOReal offset) const;

        Position getLanePosition(const MSLane* lane, SUMOReal at, SUMOReal offset) const;

        SUMOReal getEdgeAngle(const MSEdge* e, SUMOReal at) const;

        virtual void tripInfoOutput(OutputDevice& os) const = 0;

        virtual void routeOutput(OutputDevice& os) const = 0;

        virtual void beginEventOutput(const MSTransportable& transportable, SUMOTime t, OutputDevice& os) const = 0;

        virtual void endEventOutput(const MSTransportable& transportable, SUMOTime t, OutputDevice& os) const = 0;

    protected:
        const MSEdge& myDestination;

        MSStoppingPlace* const myDestinationStop;

        SUMOReal myArrivalPos;

        SUMOTime myDeparted;

        SUMOTime myArrived;

        StageType myType;

    private:
        Stage(const Stage&);

        Stage& operator=(const Stage&);

    };

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

        virtual ~Stage_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;

        ConstMSEdgeVector getEdges() const;

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

        virtual void proceed(MSNet* net, MSTransportable* transportable, SUMOTime now, Stage* previous);

        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;

    private:
        Stage_Waiting(const Stage_Waiting&);

        Stage_Waiting& operator=(const Stage_Waiting&);

    };

    class Stage_Driving : public Stage {
    public:
        Stage_Driving(const MSEdge& destination, MSStoppingPlace* toStop,
                      const SUMOReal arrivalPos, const std::vector<std::string>& lines);

        virtual ~Stage_Driving();

        void abort(MSTransportable*);

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

        Position getPosition(SUMOTime now) const;

        SUMOReal getAngle(SUMOTime now) const;

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

        bool isWaiting4Vehicle() const;

        SUMOVehicle* getVehicle() const {
            return myVehicle;
        }

        SUMOTime getWaitingTime(SUMOTime now) const;

        SUMOReal getSpeed() const;

        ConstMSEdgeVector getEdges() const;

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

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

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

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

        SUMOVehicle* myVehicle;

        SUMOReal myWaitingPos;
        SUMOTime myWaitingSince;
        const MSEdge* myWaitingEdge;
        Position myStopWaitPos;

    private:
        Stage_Driving(const Stage_Driving&);

        Stage_Driving& operator=(const Stage_Driving&);

    };

    typedef std::vector<MSTransportable::Stage*> MSTransportablePlan;

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

    virtual ~MSTransportable();

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

    const std::string& getID() const;

    inline const SUMOVehicleParameter& getParameter() const {
        return *myParameter;
    }

    inline const MSVehicleType& getVehicleType() const {
        return *myVType;
    }

    SUMOTime getDesiredDepart() const;

    void setDeparted(SUMOTime now);

    const MSEdge& getDestination() const {
        return (*myStep)->getDestination();
    }

    const MSEdge& getNextDestination() const {
        return (*(myStep + 1))->getDestination();
    }

    const MSEdge* getEdge() const {
        return (*myStep)->getEdge();
    }

    const MSEdge* getFromEdge() const {
        return (*myStep)->getFromEdge();
    }

    virtual SUMOReal getEdgePos() const;

    virtual Position getPosition() const;

    virtual SUMOReal getAngle() const;

    virtual SUMOReal getWaitingSeconds() const;

    virtual SUMOReal getSpeed() const;

    StageType getCurrentStageType() const {
        return (*myStep)->getStageType();
    }

    StageType getStageType(int next) const {
        assert(myStep + next < myPlan->end());
        assert(myStep + next >= myPlan->begin());
        return (*(myStep + next))->getStageType();
    }

    std::string getCurrentStageDescription() const {
        return (*myStep)->getStageDescription();
    }

    MSTransportable::Stage* getCurrentStage() const {
        return *myStep;
    }

    ConstMSEdgeVector getEdges(int next) const {
        assert(myStep + next < myPlan->end());
        assert(myStep + next >= myPlan->begin());
        return (*(myStep + next))->getEdges();
    }

    int getNumRemainingStages() const;

    int getNumStages() const;

    virtual void tripInfoOutput(OutputDevice& os) const = 0;

    virtual void routeOutput(OutputDevice& os) const = 0;

    bool isWaitingFor(const std::string& line) const {
        return (*myStep)->isWaitingFor(line);
    }

    bool isWaiting4Vehicle() const {
        return (*myStep)->isWaiting4Vehicle();
    }

    SUMOVehicle* getVehicle() const {
        return (*myStep)->getVehicle();
    }

    void appendStage(Stage* stage);

    void removeStage(int next);

    void setSpeed(SUMOReal speed);

    SUMOReal getArrivalPos() const {
        return myPlan->back()->getArrivalPos();
    }

    const MSEdge* getArrivalEdge() const {
        return myPlan->back()->getEdges().back();
    }

    void replaceVehicleType(MSVehicleType* type);

protected:
    static const SUMOReal ROADSIDE_OFFSET;

    const SUMOVehicleParameter* myParameter;

    const MSVehicleType* myVType;

    bool myWriteEvents;

    MSTransportablePlan* myPlan;

    MSTransportablePlan::iterator myStep;

private:
    MSTransportable(const MSTransportable&);

    MSTransportable& operator=(const MSTransportable&);

};


#endif

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