SUMO - Simulation of Urban MObility
GUIEvent_SimulationEnded Class Reference

Event sent when the the simulation is over. More...

#include <GUIEvent_SimulationEnded.h>

Inheritance diagram for GUIEvent_SimulationEnded:
GUIEvent

Public Member Functions

GUIEventType getOwnType () const
 returns the event type
MSNet::SimulationState getReason () const
 Returns the reason the simulation has ended due.
SUMOTime getTimeStep () const
 Returns the time step the simulation has ended at.
 GUIEvent_SimulationEnded (MSNet::SimulationState reason, SUMOTime step)
 Constructor.
 ~GUIEvent_SimulationEnded ()
 Destructor.

Protected Attributes

MSNet::SimulationState myReason
 The reason the simulation has ended.
SUMOTime myStep
 The time step the simulation has ended at.
GUIEventType myType
 the type of the event

Detailed Description

Event sent when the the simulation is over.

Throw from GUIRunThread to GUIApplicationWindow.

Definition at line 48 of file GUIEvent_SimulationEnded.h.


Constructor & Destructor Documentation

Constructor.

Parameters:
[in]reasonThe reason the simulation has ended
[in]stepThe time step the simulation has ended at

Definition at line 54 of file GUIEvent_SimulationEnded.h.

Destructor.

Definition at line 59 of file GUIEvent_SimulationEnded.h.


Member Function Documentation

GUIEventType GUIEvent::getOwnType ( ) const [inline, inherited]

returns the event type

Definition at line 77 of file GUIEvent.h.

References GUIEvent::myType.

Referenced by GUIApplicationWindow::eventOccured(), and GUIApplicationWindow::handleEvent_Message().

Returns the reason the simulation has ended due.

Returns:
The reason the simulation has ended

Definition at line 73 of file GUIEvent_SimulationEnded.h.

References myReason.

Referenced by GUIApplicationWindow::handleEvent_SimulationEnded().

Returns the time step the simulation has ended at.

Returns:
The time step the simulation has ended at

Definition at line 65 of file GUIEvent_SimulationEnded.h.

References myStep.

Referenced by GUIApplicationWindow::handleEvent_SimulationEnded().


Field Documentation

The reason the simulation has ended.

Definition at line 80 of file GUIEvent_SimulationEnded.h.

Referenced by getReason().

The time step the simulation has ended at.

Definition at line 83 of file GUIEvent_SimulationEnded.h.

Referenced by getTimeStep().

GUIEventType GUIEvent::myType [protected, inherited]

the type of the event

Definition at line 92 of file GUIEvent.h.

Referenced by GUIEvent::getOwnType(), and GUIEvent_Message::GUIEvent_Message().


The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines