WorkspaceUpdater (Simbrain API)

java.lang.Object
- org.simbrain.workspace.updater.WorkspaceUpdater

```
public class WorkspaceUpdater
extends java.lang.Object
```
This class manages workspace updates. "Running" and "Stepping" the simulation happen here, in a way that allows for concurrent update (in some cases) and also interacts properly with single threaded guis using a "task synchronization manager". Notification events about workspace events are fired from here. Every time the workspace is updated, a list of actions in the UpdateActionManager is invoked. By default one single action, a "buffered update", occurs, in which components are updated in parallel, and when they have all finished updating, couplings are updated. The update action manager can also be used to customize update. Three executor services are here, one for workspace updates (a single thread), one for event notification updates (a single thread), and one for component updates (a thread pool with multiple threads that can be configured), for cases when component updating happens concurrently.

Author:

Matt Watson, Jeff Yoshimi

Field Summary

Fields
Modifier and Type Field and Description

(package private) static org.apache.log4j.Logger LOGGER
The static logger for the class.

Fields
Modifier and Type	Field and Description
`(package private) static org.apache.log4j.Logger`	`LOGGER` The static logger for the class.

Constructor Summary

Constructors
Constructor and Description
`WorkspaceUpdater(Workspace workspace)` Constructor for the updater that uses the default controller and default number of threads.
`WorkspaceUpdater(Workspace workspace, int threads)` Constructor for the updater that uses the provided controller and threads.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComponentListener(ComponentUpdateListener listener)` Adds a component listener to this instance.
`void`	`addUpdaterListener(WorkspaceUpdaterListener listener)` Adds an updater listener to this instance.
`java.util.List<ComponentUpdateListener>`	`getComponentListeners()` Return list of component listeners.
`java.util.List<? extends WorkspaceComponent>`	`getComponents()` Get a synchronized list of component.
`int`	`getNumThreads()`
`int`	`getTime()` Returns the 'time' or number of update iterations that have passed.
`UpdateActionManager`	`getUpdateManager()` Returns a reference to the update manager.
`java.util.List<WorkspaceUpdaterListener>`	`getUpdaterListeners()` Return list of updater listeners.
`Workspace`	`getWorkspace()`
`boolean`	`isRunning()` Returns whether the updater is set to run.
`void`	`iterate(java.util.concurrent.CountDownLatch latch, int numIterations)` Iterate a set number of iterations against a latch.
`void`	`iterate(int numIterations)` Iterate the updater for a specified number of iterations.
`(package private) void`	`notifyComponentUpdateFinished(WorkspaceComponent component, int thread)` Called when a new component is finished updating.
`(package private) void`	`notifyComponentUpdateStarted(WorkspaceComponent component, int thread)` Called when a new component is starting to update.
`protected void`	`notifyCouplingsUpdated()` Called when the couplings are updated.
`void`	`removeComponentListener(ComponentUpdateListener listener)` Removes a component listener from this instance.
`void`	`removeUpdaterListener(WorkspaceUpdaterListener listener)` Removes an updater listener from this instance.
`void`	`resetTime()` Reset time to 0.
`void`	`run()` Starts the update thread.
`void`	`runOnce()` Submits a single task to the queue.
`void`	`runOnce(java.util.concurrent.CountDownLatch latch)` Submits a single task to the queue, and counts down a latch when done.
`void`	`setNumThreads(int numThreads)` Set number of threads in updater.
`void`	`setTaskSynchronizationManager(TaskSynchronizationManager manager)` Sets the manager.
`void`	`setTime(int time)` Sets the time.
`void`	`stop()` Stops the update thread.
`void`	`updateComponent(WorkspaceComponent component, CompletionSignal signal)` Update the provided workspace component.
`void`	`updateCouplings()` Update couplings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOGGER
```
static final org.apache.log4j.Logger LOGGER
```
    The static logger for the class.
- Constructor Detail
  - WorkspaceUpdater
```
public WorkspaceUpdater(Workspace workspace,
                        int threads)
```
    Constructor for the updater that uses the provided controller and threads.
    
    Parameters:
    
    workspace - The parent workspace.
    
    threads - The number of threads for component updates.
  - WorkspaceUpdater
```
public WorkspaceUpdater(Workspace workspace)
```
    Constructor for the updater that uses the default controller and default number of threads.
    
    Parameters:
    
    workspace - The parent workspace.
- Method Detail
  - setTaskSynchronizationManager
```
public void setTaskSynchronizationManager(TaskSynchronizationManager manager)
```
    Sets the manager. Setting the manager to null clears the manager.
    
    Parameters:
    
    manager - the new manager.
  - getTime
```
public int getTime()
```
    Returns the 'time' or number of update iterations that have passed.
    
    Returns:
    
    The time.
  - setTime
```
public void setTime(int time)
```
    Sets the time.
    
    Parameters:
    
    time - time to set
  - resetTime
```
public void resetTime()
```
    Reset time to 0.
  - stop
```
public void stop()
```
    Stops the update thread.
  - isRunning
```
public boolean isRunning()
```
    Returns whether the updater is set to run.
    
    Returns:
    
    whether the updater is set to run.
  - run
```
public void run()
```
    Starts the update thread. Used when "running" the workspace by pressing the play button in the gui.
  - runOnce
```
public void runOnce(java.util.concurrent.CountDownLatch latch)
```
    Submits a single task to the queue, and counts down a latch when done. Used when iterating the workspace for a set number of times.
    
    Parameters:
    
    latch - the latch to count down.
  - runOnce
```
public void runOnce()
```
    Submits a single task to the queue.
  - addComponentListener
```
public void addComponentListener(ComponentUpdateListener listener)
```
    Adds a component listener to this instance.
    
    Parameters:
    
    listener - The component listener to add.
  - getComponentListeners
```
public java.util.List<ComponentUpdateListener> getComponentListeners()
```
    Return list of component listeners.
    
    Returns:
    
    list of component listeners;
  - removeComponentListener
```
public void removeComponentListener(ComponentUpdateListener listener)
```
    Removes a component listener from this instance.
    
    Parameters:
    
    listener - The listener to add.
  - addUpdaterListener
```
public void addUpdaterListener(WorkspaceUpdaterListener listener)
```
    Adds an updater listener to this instance.
    
    Parameters:
    
    listener - updater component listener to add.
  - getUpdaterListeners
```
public java.util.List<WorkspaceUpdaterListener> getUpdaterListeners()
```
    Return list of updater listeners.
    
    Returns:
    
    list of updater listeners;
  - removeUpdaterListener
```
public void removeUpdaterListener(WorkspaceUpdaterListener listener)
```
    Removes an updater listener from this instance.
    
    Parameters:
    
    listener - The updater listener to add.
  - notifyComponentUpdateStarted
```
void notifyComponentUpdateStarted(WorkspaceComponent component,
                                  int thread)
```
    Called when a new component is starting to update.
    
    Parameters:
    
    component - The component to update.
    
    thread - The number of the thread doing the update.
  - notifyComponentUpdateFinished
```
void notifyComponentUpdateFinished(WorkspaceComponent component,
                                   int thread)
```
    Called when a new component is finished updating.
    
    Parameters:
    
    component - The component to update.
    
    thread - The number of the thread doing the update.
  - notifyCouplingsUpdated
```
protected void notifyCouplingsUpdated()
```
    Called when the couplings are updated.
  - getNumThreads
```
public int getNumThreads()
```
    Returns:
    
    the numThreads
  - setNumThreads
```
public void setNumThreads(int numThreads)
```
    Set number of threads in updater.
    
    Parameters:
    
    numThreads - number of threads.
  - iterate
```
public void iterate(int numIterations)
```
    Iterate the updater for a specified number of iterations.
    
    Parameters:
    
    numIterations - number of times to iterate updater.
  - iterate
```
public void iterate(java.util.concurrent.CountDownLatch latch,
                    int numIterations)
```
    Iterate a set number of iterations against a latch. See Workspace.iterate(CountDownLatch, int)
    
    Parameters:
    
    latch - the latch to count down
    
    numIterations - the number of iteration to update
  - getUpdateManager
```
public UpdateActionManager getUpdateManager()
```
    Returns a reference to the update manager.
    
    Returns:
    
    the update manager
  - getComponents
```
public java.util.List<? extends WorkspaceComponent> getComponents()
```
    Get a synchronized list of component.
    
    Returns:
    
    the synchronized list of components
  - updateComponent
```
public void updateComponent(WorkspaceComponent component,
                            CompletionSignal signal)
```
    Update the provided workspace component.
    
    Parameters:
    
    component - the component to update.
    
    signal - completion signal
  - updateCouplings
```
public void updateCouplings()
```
    Update couplings.
  - getWorkspace
```
public Workspace getWorkspace()
```
    Returns:
    
    the workspace

Class WorkspaceUpdater

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

Constructor Detail

WorkspaceUpdater

WorkspaceUpdater

Method Detail

setTaskSynchronizationManager

getTime

setTime

resetTime

stop

isRunning

run

runOnce

runOnce

addComponentListener

getComponentListeners

removeComponentListener

addUpdaterListener

getUpdaterListeners

removeUpdaterListener

notifyComponentUpdateStarted

notifyComponentUpdateFinished

notifyCouplingsUpdated

getNumThreads

setNumThreads

iterate

iterate

getUpdateManager

getComponents

updateComponent

updateCouplings

getWorkspace