MSVehicleControl.h

Go to the documentation of this file.

/****************************************************************************/
// The class responsible for building and deletion of vehicles
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
// Copyright (C) 2001-2013 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 MSVehicleControl_h
#define MSVehicleControl_h


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

#include <math.h>
#include <string>
#include <map>
#include <set>
#include "MSGlobals.h"
#include <utils/common/RandHelper.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/RandomDistributor.h>
#include <utils/common/SUMOVehicleParameter.h>


// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;
class MSVehicle;
class MSRoute;
class MSVehicleType;
class BinaryInputDevice;
class MSEdge;


// ===========================================================================
// class definitions
// ===========================================================================
class MSVehicleControl {
public:
    typedef std::map<std::string, SUMOVehicle*>::const_iterator constVehIt;

public:
    MSVehicleControl();


    virtual ~MSVehicleControl();



    virtual SUMOVehicle* buildVehicle(SUMOVehicleParameter* defs, const MSRoute* route,
                                      const MSVehicleType* type);




    virtual bool addVehicle(const std::string& id, SUMOVehicle* v);


    SUMOVehicle* getVehicle(const std::string& id) const;


    virtual void deleteVehicle(SUMOVehicle* v, bool discard = false);


    void scheduleVehicleRemoval(SUMOVehicle* veh);


    constVehIt loadedVehBegin() const;


    constVehIt loadedVehEnd() const;




    void vehicleDeparted(const SUMOVehicle& v);




    unsigned int getLoadedVehicleNo() const {
        return myLoadedVehNo;
    }


    unsigned int getEndedVehicleNo() const {
        return myEndedVehNo;
    }


    unsigned int getRunningVehicleNo() const {
        return myRunningVehNo;
    }


    unsigned int getDepartedVehicleNo() const {
        return myRunningVehNo + myEndedVehNo - myDiscarded;
    }


    bool isInQuota(SUMOReal frac = -1) const;


    int getActiveVehicleCount() const {
        return myLoadedVehNo - (myWaitingForPerson + myEndedVehNo);
    }


    unsigned int getCollisionCount() const {
        return myCollisions;
    }


    unsigned int getTeleportCount() const {
        return myTeleports;
    }


    SUMOReal getTotalDepartureDelay() const {
        return myTotalDepartureDelay;
    }


    SUMOReal getTotalTravelTime() const {
        return myTotalTravelTime;
    }




    bool addVType(MSVehicleType* vehType);


    bool addVTypeDistribution(const std::string& id, RandomDistributor<MSVehicleType*>* vehTypeDistribution);


    bool hasVTypeDistribution(const std::string& id) const;


    MSVehicleType* getVType(const std::string& id = DEFAULT_VTYPE_ID);


    void insertVTypeIDs(std::vector<std::string>& into) const;

    void addWaiting(const MSEdge* const edge, SUMOVehicle* vehicle);

    void removeWaiting(const MSEdge* const edge, SUMOVehicle* vehicle);

    SUMOVehicle* getWaitingVehicle(const MSEdge* const edge, const std::set<std::string>& lines);

    void registerOneWaitingForPerson() {
        myWaitingForPerson++;
    }

    void unregisterOneWaitingForPerson() {
        myWaitingForPerson--;
    }

    void registerCollision() {
        myTeleports++;
        myCollisions++;
    }

    void registerTeleport() {
        myTeleports++;
    }




    void setState(int runningVehNo, int endedVehNo, SUMOReal totalDepartureDelay, SUMOReal totalTravelTime);

    void saveState(OutputDevice& out);


    void abortWaiting();


public:
    static MTRand myVehicleParamsRNG;


private:
    bool checkVType(const std::string& id);

protected:

    unsigned int myLoadedVehNo;

    unsigned int myRunningVehNo;

    unsigned int myEndedVehNo;

    unsigned int myDiscarded;

    unsigned int myCollisions;

    unsigned int myTeleports;



    SUMOReal myTotalDepartureDelay;

    SUMOReal myTotalTravelTime;



    typedef std::map< std::string, SUMOVehicle* > VehicleDictType;
    VehicleDictType myVehicleDict;



    typedef std::map< std::string, MSVehicleType* > VTypeDictType;
    VTypeDictType myVTypeDict;

    typedef std::map< std::string, RandomDistributor<MSVehicleType*>* > VTypeDistDictType;
    VTypeDistDictType myVTypeDistDict;

    bool myDefaultVTypeMayBeDeleted;

    std::map<const MSEdge* const, std::vector<SUMOVehicle*> > myWaiting;

    unsigned int myWaitingForPerson;

    SUMOReal myScale;

private:
    MSVehicleControl(const MSVehicleControl& s);

    MSVehicleControl& operator=(const MSVehicleControl& s);


};


#endif

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