GUIEvent_SimulationEnded Class Reference

#include <GUIEvent_SimulationEnded.h>

Inheritance diagram for GUIEvent_SimulationEnded:

---

Detailed Description

Event sent when the the simulation is over.

Throw from GUIRunThread to GUIApplicationWindow.

Definition at line 46 of file GUIEvent_SimulationEnded.h.

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 throw ()
	Returns the time step the simulation has ended at.
	GUIEvent_SimulationEnded (MSNet::SimulationState reason, SUMOTime step) throw ()
	Constructor.
	~GUIEvent_SimulationEnded () throw ()
	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

---

Constructor & Destructor Documentation

GUIEvent_SimulationEnded::GUIEvent_SimulationEnded	(	MSNet::SimulationState	reason,
		SUMOTime	step
	)			throw () [inline]

Constructor.

Parameters:

[in]	reason	The reason the simulation has ended
[in]	step	The time step the simulation has ended at

Definition at line 52 of file GUIEvent_SimulationEnded.h.

            : GUIEvent(EVENT_SIMULATION_ENDED), myReason(reason), myStep(step) {}

GUIEvent_SimulationEnded::~GUIEvent_SimulationEnded

(

)

throw () [inline]

Destructor.

Definition at line 57 of file GUIEvent_SimulationEnded.h.

{ }

---

Member Function Documentation

GUIEventType GUIEvent::getOwnType

(

)

const [inline, inherited]

returns the event type

Definition at line 76 of file GUIEvent.h.

References GUIEvent::myType.

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

                                    {
        return myType;
    }

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 71 of file GUIEvent_SimulationEnded.h.

References myReason.

Referenced by GUIApplicationWindow::handleEvent_SimulationEnded().

                                           {
        return myReason;
    }

SUMOTime GUIEvent_SimulationEnded::getTimeStep

(

)

const throw () [inline]

Returns the time step the simulation has ended at.

Returns:

The time step the simulation has ended at

Definition at line 63 of file GUIEvent_SimulationEnded.h.

References myStep.

Referenced by GUIApplicationWindow::handleEvent_SimulationEnded().

                                         {
        return myStep;
    }

---

Field Documentation

MSNet::SimulationState GUIEvent_SimulationEnded::myReason [protected]

The reason the simulation has ended.

Definition at line 78 of file GUIEvent_SimulationEnded.h.

Referenced by getReason().

SUMOTime GUIEvent_SimulationEnded::myStep [protected]

The time step the simulation has ended at.

Definition at line 81 of file GUIEvent_SimulationEnded.h.

Referenced by getTimeStep().

GUIEventType GUIEvent::myType [protected, inherited]

the type of the event

Definition at line 91 of file GUIEvent.h.

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

---

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

• GUIEvent_SimulationEnded.h