Interface IProbe
-
- All Known Implementing Classes:
AbstractProbe
,AbstractProbeImageSwingJPanel
,AbstractRealTimeMatcherProbe
,ProbeExceptionPrinter
,ProbeExecutionTracker
,ProbeImageSwingJFrame
public interface IProbe
Models an observation probe extracting data from the simulation when at least one level becomes consistent.- Author:
- Yoann Kubera
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
endObservation()
Ends the observation of a simulation.void
observeAtFinalTime(SimulationTimeStamp finalTimestamp, ISimulationEngine simulationEngine)
Observes the state of the simulation when the final time stamp of the simulation is reached.void
observeAtInitialTimes(SimulationTimeStamp initialTimestamp, ISimulationEngine simulationEngine)
Observes the state of the simulation when the initial time stamp is reached.void
observeAtPartialConsistentTime(SimulationTimeStamp timestamp, ISimulationEngine simulationEngine)
Observes the state of the simulation when at least one level is in a consistent state.void
prepareObservation()
Prepares the observation of a simulation.void
reactToAbortion(SimulationTimeStamp timestamp, ISimulationEngine simulationEngine)
Reacts to the abortion of a currently running simulation.void
reactToError(String errorMessage, Throwable cause)
Reacts to an error thrown by the simulation engine.
-
-
-
Method Detail
-
prepareObservation
void prepareObservation()
Prepares the observation of a simulation.This method is defined to open the streams or the other resources used during the observation of one simulation.
-
observeAtInitialTimes
void observeAtInitialTimes(SimulationTimeStamp initialTimestamp, ISimulationEngine simulationEngine)
Observes the state of the simulation when the initial time stamp is reached.- Parameters:
initialTimestamp
- The initial time stamp of the simulation.simulationEngine
- The simulation engine embedding the currently running simulation and the current dynamic state of the various levels of the simulation.
-
observeAtPartialConsistentTime
void observeAtPartialConsistentTime(SimulationTimeStamp timestamp, ISimulationEngine simulationEngine)
Observes the state of the simulation when at least one level is in a consistent state.- Parameters:
timestamp
- The time stamp for which at least one level of the simulation is a consistent state.simulationEngine
- The simulation engine embedding the currently running simulation and the current dynamic state of the various levels of the simulation.
-
observeAtFinalTime
void observeAtFinalTime(SimulationTimeStamp finalTimestamp, ISimulationEngine simulationEngine)
Observes the state of the simulation when the final time stamp of the simulation is reached.- Parameters:
finalTimestamp
- The final time stamp of the simulation.simulationEngine
- The simulation engine embedding the currently running simulation and the current dynamic state of the various levels of the simulation.
-
reactToError
void reactToError(String errorMessage, Throwable cause)
Reacts to an error thrown by the simulation engine.- Parameters:
cause
- The cause of the error.
-
reactToAbortion
void reactToAbortion(SimulationTimeStamp timestamp, ISimulationEngine simulationEngine)
Reacts to the abortion of a currently running simulation.- Parameters:
timestamp
- The time stamp reached right after the moment when the abortion was requested.simulationEngine
- The simulation engine embedding the aborted simulation and the dynamic state of the various levels of the simulation after abortion.
-
endObservation
void endObservation()
Ends the observation of a simulation.This method is defined to close the streams or the other resources used during the observation of one simulation.
-
-