All Implemented Interfaces:

it.unibo.alchemist.core.Simulation , java.lang.Runnable
```
public class Engine<T, P extends Position<out P>>
 implements Simulation<T, P>
                    
```
This class implements a simulation. It offers a wide number of static factories to ease the creation process.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final Environment<T, P>`	`environment`
`public volatile Status`	`status`
`public Optional<Throwable>`	`error`

Constructor Summary

Constructors
Constructor	Description
`Engine(Environment<T, P> environment)`	Builds a simulation for a given environment.
`Engine(Environment<T, P> environment, Scheduler<T> scheduler)`	Builds a simulation for a given environment.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Environment<T, P>`	`getEnvironment()`
`Status`	`getStatus()`
`Optional<Throwable>`	`getError()`
`void`	`addOutputMonitor(OutputMonitor<T, P> op)`
`synchronized long`	`getStep()`	thread-safe.
`synchronized Time`	`getTime()`	thread-safe.
`CompletableFuture<Void>`	`goToStep(long step)`
`CompletableFuture<Void>`	`goToTime(Time t)`
`void`	`neighborAdded(Node<T> node, Node<T> n)`
`void`	`neighborRemoved(Node<T> node, Node<T> n)`
`void`	`nodeAdded(Node<T> node)`
`void`	`nodeMoved(Node<T> node)`
`void`	`nodeRemoved(Node<T> node, Neighborhood<T> oldNeighborhood)`
`CompletableFuture<Void>`	`pause()`	pause.
`CompletableFuture<Void>`	`play()`	play.
`void`	`reactionAdded(Actionable<T> reactionToAdd)`
`void`	`reactionRemoved(Actionable<T> reactionToRemove)`
`void`	`removeOutputMonitor(OutputMonitor<T, P> op)`
`void`	`run()`	run simulation.
`void`	`schedule(CheckedRunnable runnable)`
`CompletableFuture<Void>`	`terminate()`	terminate.
`String`	`toString()`
`Status`	`waitFor(Status next, long timeout, TimeUnit tu)`
`List<OutputMonitor<T, P>>`	`getOutputMonitors()`	Returns output monitors.

Methods inherited from class it.unibo.alchemist.core.Simulation
getEnvironment, getError, getStatus
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Engine
```
Engine(Environment<T, P> environment)
```
    Builds a simulation for a given environment.
    
    Parameters:
    
    environment - the environment at the initial time
  - Engine
```
Engine(Environment<T, P> environment, Scheduler<T> scheduler)
```
    Builds a simulation for a given environment.
    
    Parameters:
    
    environment - maxTime he environment at the initial time
    
    scheduler - the scheduler implementation to be used
- Method Detail
  - getEnvironment
```
 Environment<T, P> getEnvironment()
```
    Returns:
    
    environment
  - getStatus
```
 Status getStatus()
```
    Returns:
    
    status
  - getError
```
 Optional<Throwable> getError()
```
    Returns:
    
    error
  - addOutputMonitor
```
 void addOutputMonitor(OutputMonitor<T, P> op)
```
    Parameters:
    
    op - the OutputMonitor to add
  - getStep
```
 synchronized long getStep()
```
    thread-safe.
    
    Returns:
    
    step
  - getTime
```
 synchronized Time getTime()
```
    thread-safe.
    
    Returns:
    
    time
  - goToStep
```
 CompletableFuture<Void> goToStep(long step)
```
    Parameters:
    
    step - the number of steps to execute
  - goToTime
```
 CompletableFuture<Void> goToTime(Time t)
```
    Parameters:
    
    t - the target time
  - neighborAdded
```
 void neighborAdded(Node<T> node, Node<T> n)
```
    Parameters:
    
    node - the node
    
    n - the second node
  - neighborRemoved
```
 void neighborRemoved(Node<T> node, Node<T> n)
```
    Parameters:
    
    node - the node
    
    n - the second node
  - nodeAdded
```
 void nodeAdded(Node<T> node)
```
    Parameters:
    
    node - the freshly added node
  - nodeMoved
```
 void nodeMoved(Node<T> node)
```
    Parameters:
    
    node - the node
  - nodeRemoved
```
 void nodeRemoved(Node<T> node, Neighborhood<T> oldNeighborhood)
```
    Parameters:
    
    node - the freshly removed node
    
    oldNeighborhood - the neighborhood of the node as it was before it was removed (used to calculate reverse dependencies)
  - pause
```
 CompletableFuture<Void> pause()
```
    pause.
  - play
```
 CompletableFuture<Void> play()
```
    play.
  - reactionAdded
```
 void reactionAdded(Actionable<T> reactionToAdd)
```
    Parameters:
    
    reactionToAdd - the reaction to add
  - reactionRemoved
```
 void reactionRemoved(Actionable<T> reactionToRemove)
```
    Parameters:
    
    reactionToRemove - the reaction to remove
  - removeOutputMonitor
```
 void removeOutputMonitor(OutputMonitor<T, P> op)
```
    Parameters:
    
    op - the OutputMonitor to add
  - run
```
 void run()
```
    run simulation.
  - schedule
```
 void schedule(CheckedRunnable runnable)
```
    Parameters:
    
    runnable - the runnable to execute
  - terminate
```
 CompletableFuture<Void> terminate()
```
    terminate.
  - toString
```
 String toString()
```
    Returns:
    
    string representation of the engine
  - waitFor
```
 Status waitFor(Status next, long timeout, TimeUnit tu)
```
    Parameters:
    
    next - The Status the simulation should reach before returning from this method
    
    timeout - The maximum lapse of time the caller wants to wait before being resumed
    
    tu - The TimeUnit used to define "timeout"
    
    Returns:
    
    status
  - getOutputMonitors
```
 List<OutputMonitor<T, P>> getOutputMonitors()
```
    Returns output monitors.
    
    Returns:
    
    output monitors

Class Engine

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class it.unibo.alchemist.core.Simulation

Methods inherited from class java.lang.Object

Constructor Detail

Engine

Engine

Method Detail

getEnvironment

getStatus

getError

addOutputMonitor

getStep

getTime

goToStep

goToTime

neighborAdded

neighborRemoved

nodeAdded

nodeMoved

nodeRemoved

pause

play

reactionAdded

reactionRemoved

removeOutputMonitor

run

schedule

terminate

toString

waitFor

getOutputMonitors