MSContainer.h

Go to the documentation of this file.

/****************************************************************************/
// The class for modelling container-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 MSContainer_h
#define MSContainer_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 MSCModel_NonInteracting;
class CState;


// ===========================================================================
// class definitions
// ===========================================================================
class MSContainer : public MSTransportable {
public:
    static const SUMOReal ROADSIDE_OFFSET;


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

        ~MSContainerStage_Driving();

        virtual void proceed(MSNet* net, MSTransportable* container, 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;

        MSStoppingPlace* getDepartContainerStop() const;

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

        virtual void tripInfoOutput(OutputDevice& os) const;

        virtual void routeOutput(OutputDevice& os) const;

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

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

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

        SUMOVehicle* myVehicle;

        MSStoppingPlace* myDestinationContainerStop;

        MSStoppingPlace* myDepartContainerStop;

        SUMOReal myWaitingPos;

        SUMOTime myWaitingSince;

        const MSEdge* myWaitingEdge;

    private:
        MSContainerStage_Driving(const MSContainerStage_Driving&);

        MSContainerStage_Driving& operator=(const MSContainerStage_Driving&);

    };

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

        ~MSContainerStage_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 + ")";
        }

        /* @brief returns the container stop at which the container is waiting
         *
         * this method was added to have a method 'getDepartContainerStop'
         * for MSContainer.
         */
        MSStoppingPlace* getDepartContainerStop() const;

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

        virtual void tripInfoOutput(OutputDevice& os) const;

        virtual void routeOutput(OutputDevice& os) const;

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

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

    private:
        SUMOTime myWaitingDuration;

        SUMOTime myWaitingUntil;

        SUMOTime myWaitingStart;

        std::string myActType;

        SUMOReal myStartPos;

        MSStoppingPlace* myCurrentContainerStop;


    private:
        MSContainerStage_Waiting(const MSContainerStage_Waiting&);

        MSContainerStage_Waiting& operator=(const MSContainerStage_Waiting&);

    };

    class MSContainerStage_Tranship : public MSTransportable::Stage {
        friend class MSCModel_NonInteracting;

    public:
        MSContainerStage_Tranship(const std::vector<const MSEdge*>& route, MSStoppingPlace* toCS, SUMOReal speed, SUMOReal departPos, SUMOReal arrivalPos);

        ~MSContainerStage_Tranship();

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

        const MSEdge* getEdge() const;

        const MSEdge* getFromEdge() const;

        const MSEdge* getToEdge() 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 "tranship";
        }

        MSStoppingPlace* getDepartContainerStop() const;

        virtual void tripInfoOutput(OutputDevice& os) const;

        virtual void routeOutput(OutputDevice& os) const;

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

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

        bool moveToNextEdge(MSTransportable* container, 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* getNextRouteEdge() const {
            return myRouteStep == myRoute.end() - 1 ? 0 : *(myRouteStep + 1);
        }

        CState* getContainerState() const {
            return myContainerState;
        }

    private:
        std::vector<const MSEdge*> myRoute;

        std::vector<const MSEdge*>::iterator myRouteStep;

        SUMOReal myDepartPos;

        SUMOReal myArrivalPos;

        MSStoppingPlace* myDestinationContainerStop;

        MSStoppingPlace* myDepartContainerStop;

        SUMOReal mySpeed;

        CState* myContainerState;

        MSEdge* myCurrentInternalEdge;

    private:
        MSContainerStage_Tranship(const MSContainerStage_Tranship&);

        MSContainerStage_Tranship& operator=(const MSContainerStage_Tranship&);

    };

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

    virtual ~MSContainer();

    /* @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;

private:
    MSContainer(const MSContainer&);

    MSContainer& operator=(const MSContainer&);

};


#endif

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