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:
Inheritance graph
Collaboration diagram for GUIEvent_SimulationEnded:
Collaboration graph

Public Member Functions

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

Protected Attributes

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

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

◆ GUIEvent_SimulationEnded()

GUIEvent_SimulationEnded::GUIEvent_SimulationEnded ( MSNet::SimulationState  reason,
SUMOTime  step 
)
inline

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.

◆ ~GUIEvent_SimulationEnded()

GUIEvent_SimulationEnded::~GUIEvent_SimulationEnded ( )
inline

Destructor.

Definition at line 59 of file GUIEvent_SimulationEnded.h.

Member Function Documentation

◆ getOwnType()

GUIEventType GUIEvent::getOwnType ( ) const
inlineinherited

◆ getReason()

MSNet::SimulationState GUIEvent_SimulationEnded::getReason ( ) const
inline

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().

◆ getTimeStep()

SUMOTime GUIEvent_SimulationEnded::getTimeStep ( ) const
inline

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

◆ myReason

MSNet::SimulationState GUIEvent_SimulationEnded::myReason
protected

The reason the simulation has ended.

Definition at line 80 of file GUIEvent_SimulationEnded.h.

Referenced by getReason().

◆ myStep

SUMOTime GUIEvent_SimulationEnded::myStep
protected

The time step the simulation has ended at.

Definition at line 83 of file GUIEvent_SimulationEnded.h.

Referenced by getTimeStep().

◆ myType

GUIEventType GUIEvent::myType
protectedinherited

the type of the event

Definition at line 99 of file GUIEvent.h.

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


The documentation for this class was generated from the following file: