SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GUIEvent_SimulationEnded.h
Go to the documentation of this file.
1 /****************************************************************************/
8 // Event sent when the the simulation is over
9 /****************************************************************************/
10 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
11 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
12 /****************************************************************************/
13 //
14 // This file is part of SUMO.
15 // SUMO is free software: you can redistribute it and/or modify
16 // it under the terms of the GNU General Public License as published by
17 // the Free Software Foundation, either version 3 of the License, or
18 // (at your option) any later version.
19 //
20 /****************************************************************************/
21 #ifndef GUIEvent_SimulationEnded_h
22 #define GUIEvent_SimulationEnded_h
23 
24 
25 // ===========================================================================
26 // included modules
27 // ===========================================================================
28 #ifdef _MSC_VER
29 #include <windows_config.h>
30 #else
31 #include <config.h>
32 #endif
33 
35 #include <utils/common/SUMOTime.h>
36 #include <microsim/MSNet.h>
37 
38 
39 // ===========================================================================
40 // class definitions
41 // ===========================================================================
49 public:
55  : GUIEvent(EVENT_SIMULATION_ENDED), myReason(reason), myStep(step) {}
56 
57 
60 
61 
66  return myStep;
67  }
68 
69 
74  return myReason;
75  }
76 
77 
78 protected:
81 
84 
85 
86 };
87 
88 
89 #endif
90 
91 /****************************************************************************/
92 
Event sent when the the simulation is over.
SUMOTime myStep
The time step the simulation has ended at.
MSNet::SimulationState getReason() const
Returns the reason the simulation has ended due.
SimulationState
Possible states of a simulation - running or stopped with different reasons.
Definition: MSNet.h:92
GUIEvent_SimulationEnded(MSNet::SimulationState reason, SUMOTime step)
Constructor.
MSNet::SimulationState myReason
The reason the simulation has ended.
Send when the simulation is over; The reason and the time step are stored within the event...
Definition: GUIEvent.h:60
SUMOTime getTimeStep() const
Returns the time step the simulation has ended at.