MSEventControl.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Stores time-dependant events and executes them at the proper time
/****************************************************************************/
#pragma once
#include <config.h>
 
#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;
 
 
public:
    MSEventControl();
 
 
    virtual ~MSEventControl();
 
 
    virtual void addEvent(Command* operation, SUMOTime execTimeStep = -1);
 
 
    virtual void execute(SUMOTime time);
 
 
    bool isEmpty();
 
    void clearState(SUMOTime currentTime, SUMOTime newTime);
 
    SUMOTime getEventTime(Command* cmd) const;
 
protected:
    static bool eventCompare(const Event& e1, const Event& e2);
 
 
private:
    std::vector<Event> myEvents;
 
 
private:
    MSEventControl(const MSEventControl&);
 
    MSEventControl& operator=(const MSEventControl&);
 
 
};