GUIEvent_SimulationEnded.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
/****************************************************************************/
// Event sent when the simulation is over
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/gui/events/GUIEvent.h>
#include <utils/common/SUMOTime.h>
#include <microsim/MSNet.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIEvent_SimulationEnded : public GUIEvent {
public:
    GUIEvent_SimulationEnded(MSNet::SimulationState reason, SUMOTime step)
        : GUIEvent(GUIEventType::SIMULATION_ENDED), myReason(reason), myStep(step) {}
 
 
    ~GUIEvent_SimulationEnded() { }
 
 
    SUMOTime getTimeStep() const {
        return myStep;
    }
 
 
    MSNet::SimulationState getReason() const {
        return myReason;
    }
 
 
protected:
    MSNet::SimulationState myReason;
 
    SUMOTime myStep;
 
 
};