MSEventControl.h

Go to the documentation of this file.

/****************************************************************************/
// Stores time-dependant events and executes them at the proper time
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program 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 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSEventControl_h
#define MSEventControl_h


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

#include <utility>
#include <queue>
#include <vector>
#include <map>
#include <utils/common/SUMOTime.h>
#include <utils/common/UtilExceptions.h>


// ===========================================================================
// class declarations
// ===========================================================================
class Command;


// ===========================================================================
// class definitions
// ===========================================================================
class MSEventControl {
public:
    typedef std::pair< Command*, SUMOTime > Event;


    enum AdaptType {
        ADAPT_AFTER_EXECUTION = 1,
        NO_CHANGE = 2
    };


public:
    MSEventControl() throw();


    virtual ~MSEventControl() throw();


    virtual SUMOTime addEvent(Command* operation, SUMOTime execTimeStep,
                              AdaptType type) throw();


    virtual void execute(SUMOTime time) throw(ProcessError);


    bool isEmpty() throw();


    void setCurrentTimeStep(SUMOTime time);


protected:
    class EventSortCrit {
    public:
        bool operator()(const Event& e1, const Event& e2) const {
            return e1.second > e2.second;
        }
    };


private:
    typedef std::priority_queue< Event, std::vector< Event >, EventSortCrit > EventCont;

    SUMOTime currentTimeStep;

    EventCont myEvents;

    SUMOTime getCurrentTimeStep() throw();


private:
    MSEventControl(const MSEventControl&);

    MSEventControl& operator=(const MSEventControl&);


};


#endif

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