Package mars.simulator

Class SimulatorPauseEvent

java.lang.Object

java.util.EventObject

mars.simulator.SimulatorPauseEvent

All Implemented Interfaces:

Serializable

public class SimulatorPauseEvent
extends EventObject

Event for when the simulator stops execution of a program due to pausing. Note that the return value of EventObject.getSource() will always be a Simulator.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SimulatorPauseEvent.Reason	Enumeration of reasons for why the simulator might pause.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SimulatorPauseEvent(Simulator simulator, int stepCount, SimulatorPauseEvent.Reason reason)	Construct a new event with the given parameters.

Method Summary

Modifier and Type	Method	Description
SimulatorPauseEvent.Reason	getReason()	The reason why execution paused.
int	getStepCount()	The number of steps the simulator took (-1 if not applicable).

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SimulatorPauseEvent

public SimulatorPauseEvent(Simulator simulator,
 int stepCount,
 SimulatorPauseEvent.Reason reason)

Construct a new event with the given parameters.

Parameters:

simulator - The source of this event.

stepCount - The number of steps the simulator took (-1 if not applicable).

reason - The reason why execution paused.

Method Details

getStepCount

public int getStepCount()

The number of steps the simulator took (-1 if not applicable).

getReason

public SimulatorPauseEvent.Reason getReason()

The reason why execution paused.