Package it.unibo.alchemist.boundary

Interface OutputMonitor

  • All Implemented Interfaces:
    java.io.Serializable 
    
public interface OutputMonitor<T, P extends Position<out P>>
 implements Serializable

    An interface for the visualization of the simulation.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      void finished(@Nonnull() Environment<T, P> environment, @Nonnull() Time time, long step) This method will be called by the simulation once the whole simulation has finished, either because it reached its latest point or because the user stopped it.
      void initialized(@Nonnull() Environment<T, P> environment) This method will be called by the simulation as soon as the initialization phase is completed.
      void stepDone(@Nonnull() Environment<T, P> environment, @Nullable() Actionable<T> reaction, @Nonnull() Time time, long step) This method will be called by the simulation every time a simulation step is done.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • finished

         void finished(@Nonnull() Environment<T, P> environment, @Nonnull() Time time, long step)

        This method will be called by the simulation once the whole simulation has finished, either because it reached its latest point or because the user stopped it. Thread safety note: no specific policy is defined for the control flow which will execute this method. A new thread could have been spawned or the same flow of the simulation may execute this method. This depends on the specific it.unibo.alchemist.core.Simulation implementation.

        Parameters:
        environment - The current environment
        time - The time at which the simulation ended
        step - The last step number

      • initialized

         void initialized(@Nonnull() Environment<T, P> environment)

        This method will be called by the simulation as soon as the initialization phase is completed. Thread safety note: no specific policy is defined for the control flow which will execute this method. A new thread could have been spawned or the same flow of the simulation may execute this method. This depends on the specific it.unibo.alchemist.core.Simulation implementation.

        Parameters:
        environment - the environment

      • stepDone

         void stepDone(@Nonnull() Environment<T, P> environment, @Nullable() Actionable<T> reaction, @Nonnull() Time time, long step)

        This method will be called by the simulation every time a simulation step is done. Thread safety note: no specific policy is defined for the control flow which will execute this method. A new thread could have been spawned or the same flow of the simulation may execute this method. This depends on the specific it.unibo.alchemist.core.Simulation implementation.

        Parameters:
        environment - The current environment
        reaction - The last reaction executed
        time - The time at this simulation point
        step - The current simulation step