Workspace (Simbrain API)

java.lang.Object
- org.simbrain.workspace.Workspace

```
public class Workspace
extends java.lang.Object
```
A collection of components which interact via couplings. Neural networks, data-tables, gauges, and scripts are examples of components in a Simbrain workspace. Essentially, an instance of a workspace corresponds to a single simulation (though at some point it will be possible to link multiple workspaces on different machines together). A workspace can be visualized via a SimbrainDesktop.

See Also:

Coupling

Constructor Summary

Constructors
Constructor and Description

Workspace()
Construct a workspace.

Constructors
Constructor and Description
`Workspace()` Construct a workspace.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCoupling(Coupling<?> coupling)` Adds a coupling to the CouplingManager.
`void`	`addListener(WorkspaceListener listener)` Adds a listener to the workspace.
`void`	`addUpdateAction(UpdateAction action)` Convenience method for adding an update action to the workspace's action list (the sequence of actions invoked on each iteration of the workspace).
`void`	`addWorkspaceComponent(WorkspaceComponent component)` Adds a workspace component to the workspace.
`boolean`	`changesExist()` Check whether there have been changes in the workspace or its components.
`void`	`clearWorkspace()` Remove all components (networks, worlds, etc.) from this workspace.
`void`	`coupleOneToMany(java.util.List<PotentialProducer> sourceAttributes, java.util.List<PotentialConsumer> targetAttributes)` Couple each source attribute to all target attributes.
`void`	`coupleOneToOne(java.util.List<PotentialProducer> producerKeys, java.util.List<PotentialConsumer> consumerKeys)` Couple each source attribute to one target attribute, as long as there are target attributes to couple to.
`WorkspaceComponent`	`getComponent(java.lang.String id)` Get a component using its name id.
`java.util.List<? extends WorkspaceComponent>`	`getComponentList()`
`java.util.Collection<? extends WorkspaceComponent>`	`getComponentList(java.lang.Class<?> componentType)` Returns all components of the specified type, e.g.
`Coupling<?>`	`getCoupling(java.lang.String id)` Returns the coupling associated with a string id.
`CouplingManager`	`getCouplingManager()` Returns the coupling manager for this workspace.
`java.lang.String`	`getCurrentDirectory()`
`java.io.File`	`getCurrentFile()`
`protected int`	`getSavedTime()`
`int`	`getTime()` Returns global time.
`int`	`getUpdateDelay()`
`WorkspaceUpdater`	`getUpdater()` Returns a reference to the workspace updater.
`void`	`iterate()` Update the workspace a single time.
`void`	`iterate(java.util.concurrent.CountDownLatch latch)` Iterate using a latch, which is counted down after the iteration completes.
`void`	`iterate(java.util.concurrent.CountDownLatch latch, int numIterations)` Iterated for a specified number of iterations using a latch.
`void`	`iterate(int numIterations)` Iterate for a specified number of steps.
`void`	`openWorkspace(java.io.File theFile)` Open a workspace from a file.
`(package private) void`	`preSerializationInit()` Actions required prior to proper serialization.
`void`	`removeAllComponents()` Disposes all Simbrain Windows.
`void`	`removeCoupling(Coupling<?> coupling)` Removes a coupling from the CouplingManager.
`void`	`removeListener(WorkspaceListener listener)` Removes the listener from the workspace.
`void`	`removeWorkspaceComponent(WorkspaceComponent component)` Remove the specified component.
`void`	`resetTime()` Reset time.
`void`	`run()` Iterates all couplings on all components until halted by user.
`void`	`setCurrentDirectory(java.lang.String currentDirectory)`
`void`	`setCurrentFile(java.io.File currentFile)`
`void`	`setTaskSynchronizationManager(TaskSynchronizationManager manager)` Set the task synchronization manager.
`void`	`setUpdateDelay(int updateDelay)`
`void`	`setWorkspaceChanged(boolean workspaceChanged)` Sets whether the workspace has been changed.
`void`	`stop()` Stops iteration of all couplings on all components.
`<E> E`	`syncOnAllComponents(java.util.concurrent.Callable<E> task)` Synchronizes on all components and executes task, returning the result of that callable.
`static <E> E`	`syncRest(java.util.Iterator<? extends java.lang.Object> iterator, java.util.concurrent.Callable<E> task)` Recursively synchronizes on the components in the provided iterator and executes the provided task if there are no more components.
`java.lang.String`	`toString()`
`(package private) void`	`updateStopped()` Should be called when updating is stopped.

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

- Constructor Detail
  - Workspace
```
public Workspace()
```
    Construct a workspace.
- Method Detail
  - addListener
```
public void addListener(WorkspaceListener listener)
```
    Adds a listener to the workspace.
    
    Parameters:
    
    listener - the Listener to add.
  - removeListener
```
public void removeListener(WorkspaceListener listener)
```
    Removes the listener from the workspace.
    
    Parameters:
    
    listener - The listener to remove.
  - coupleOneToMany
```
public void coupleOneToMany(java.util.List<PotentialProducer> sourceAttributes,
                            java.util.List<PotentialConsumer> targetAttributes)
```
    Couple each source attribute to all target attributes.
    
    Parameters:
    
    sourceAttributes - source producing attributes
    
    targetAttributes - target consuming attributes
  - coupleOneToOne
```
public void coupleOneToOne(java.util.List<PotentialProducer> producerKeys,
                           java.util.List<PotentialConsumer> consumerKeys)
                    throws UmatchedAttributesException
```
    Couple each source attribute to one target attribute, as long as there are target attributes to couple to.
    
    Parameters:
    
    producerKeys - source producing attributes
    
    consumerKeys - target consuming attributes
    
    Throws:
    
    UmatchedAttributesException
  - addWorkspaceComponent
```
public void addWorkspaceComponent(WorkspaceComponent component)
```
    Adds a workspace component to the workspace.
    
    Parameters:
    
    component - The component to add.
  - removeWorkspaceComponent
```
public void removeWorkspaceComponent(WorkspaceComponent component)
```
    Remove the specified component.
    
    Parameters:
    
    component - The component to remove.
  - updateStopped
```
void updateStopped()
```
    Should be called when updating is stopped.
  - iterate
```
public void iterate()
```
    Update the workspace a single time.
  - iterate
```
public void iterate(int numIterations)
```
    Iterate for a specified number of steps.
    
    Parameters:
    
    numIterations - number of times to iterate the workspace.
  - iterate
```
public void iterate(java.util.concurrent.CountDownLatch latch,
                    int numIterations)
```
    Iterated for a specified number of iterations using a latch. Used in scripts when making a series of events occur, e.g. set some neurons, run for 50 iterations, set some other neurons, run 20 iterations, etc. The latch must be initialized with a count of 1 and must be run from a separate thread. For example:
```
 
  Executors.newSingleThreadExecutor().execute(new Runnable() {
               public void run() {
                   // Do one thing
                    CountDownLatch latch = new CountDownLatch(1);
                    workspace.iterate(latch, 100);
                    try {
                        latch.await();
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                    // Do another
                    CountDownLatch latch = new CountDownLatch(1);
                    workspace.iterate(latch, 100);
                    try {
                        latch.await();
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
               }
            });
 }
 
```
    Parameters:
    
    latch - the latch to wait on
    
    numIterations - the number of iteration to run while waiting on the latch
  - iterate
```
public void iterate(java.util.concurrent.CountDownLatch latch)
```
    Iterate using a latch, which is counted down after the iteration completes. Use this in applications where it is important to perform additional operations after each workspace update. NOTE-1: The latch must be initialized with a count of 1. NOTE-2: This function should be called from a separate thread.
    
    Parameters:
    
    latch - the latch to count down after successful iteration.
  - run
```
public void run()
```
    Iterates all couplings on all components until halted by user.
  - stop
```
public void stop()
```
    Stops iteration of all couplings on all components.
  - clearWorkspace
```
public void clearWorkspace()
```
    Remove all components (networks, worlds, etc.) from this workspace.
  - removeAllComponents
```
public void removeAllComponents()
```
    Disposes all Simbrain Windows.
  - changesExist
```
public boolean changesExist()
```
    Check whether there have been changes in the workspace or its components.
    
    Returns:
    
    true if changes exist, false otherwise
  - setWorkspaceChanged
```
public void setWorkspaceChanged(boolean workspaceChanged)
```
    Sets whether the workspace has been changed.
    
    Parameters:
    
    workspaceChanged - Has workspace been changed value
  - getCurrentDirectory
```
public java.lang.String getCurrentDirectory()
```
    Returns:
    
    the currentDirectory
  - setCurrentDirectory
```
public void setCurrentDirectory(java.lang.String currentDirectory)
```
    Parameters:
    
    currentDirectory - the currentDirectory to set
  - getCurrentFile
```
public java.io.File getCurrentFile()
```
    Returns:
    
    Returns the currentFile.
  - setCurrentFile
```
public void setCurrentFile(java.io.File currentFile)
```
    Parameters:
    
    currentFile - The current_file to set.
  - getComponentList
```
public java.util.List<? extends WorkspaceComponent> getComponentList()
```
    Returns:
    
    the componentList
  - getComponent
```
public WorkspaceComponent getComponent(java.lang.String id)
```
    Get a component using its name id. Used in terminal mode.
    
    Parameters:
    
    id - name of component
    
    Returns:
    
    Workspace Component
  - getCoupling
```
public Coupling<?> getCoupling(java.lang.String id)
```
    Returns the coupling associated with a string id.
    
    Parameters:
    
    id - the string id
    
    Returns:
    
    the associated coupling
  - setTaskSynchronizationManager
```
public void setTaskSynchronizationManager(TaskSynchronizationManager manager)
```
    Set the task synchronization manager.
    
    Parameters:
    
    manager -
  - syncOnAllComponents
```
public <E> E syncOnAllComponents(java.util.concurrent.Callable<E> task)
                          throws java.lang.Exception
```
    Synchronizes on all components and executes task, returning the result of that callable.
    
    Type Parameters:
    
    E - The return type of task.
    
    Parameters:
    
    task - The task to synchronize.
    
    Returns:
    
    The result of task.
    
    Throws:
    
    java.lang.Exception - if an exception occurs.
  - syncRest
```
public static <E> E syncRest(java.util.Iterator<? extends java.lang.Object> iterator,
                             java.util.concurrent.Callable<E> task)
                      throws java.lang.Exception
```
    Recursively synchronizes on the components in the provided iterator and executes the provided task if there are no more components.
    
    Type Parameters:
    
    E - The return type of task.
    
    Parameters:
    
    iterator - The iterator of the remaining components to synchronize on.
    
    task - The task to synchronize.
    
    Returns:
    
    The result of the task.
    
    Throws:
    
    java.lang.Exception - if an exception occurs.
  - getCouplingManager
```
public CouplingManager getCouplingManager()
```
    Returns the coupling manager for this workspace.
    
    Returns:
    
    The coupling manager for this workspace.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - addCoupling
```
public void addCoupling(Coupling<?> coupling)
```
    Adds a coupling to the CouplingManager.
    
    Parameters:
    
    coupling - The coupling to add.
  - removeCoupling
```
public void removeCoupling(Coupling<?> coupling)
```
    Removes a coupling from the CouplingManager.
    
    Parameters:
    
    coupling - The coupling to remove.
  - getComponentList
```
public java.util.Collection<? extends WorkspaceComponent> getComponentList(java.lang.Class<?> componentType)
```
    Returns all components of the specified type, e.g. all WorkspaceComponents of type NetworkComponent.class.
    
    Parameters:
    
    componentType - the type of the component, in the sense of its class
    
    Returns:
    
    list of components
  - getTime
```
public int getTime()
```
    Returns global time.
    
    Returns:
    
    the time
  - getSavedTime
```
protected int getSavedTime()
```
    Returns:
    
    the savedTime
  - resetTime
```
public void resetTime()
```
    Reset time.
  - getUpdater
```
public WorkspaceUpdater getUpdater()
```
    Returns a reference to the workspace updater.
    
    Returns:
    
    reference to workspace updater.
  - getUpdateDelay
```
public int getUpdateDelay()
```
    Returns:
    
    the updateDelay
  - setUpdateDelay
```
public void setUpdateDelay(int updateDelay)
```
    Parameters:
    
    updateDelay - the updateDelay to set
  - preSerializationInit
```
void preSerializationInit()
```
    Actions required prior to proper serialization.
  - openWorkspace
```
public void openWorkspace(java.io.File theFile)
```
    Open a workspace from a file.
    
    Parameters:
    
    theFile - the file to try to open
  - addUpdateAction
```
public void addUpdateAction(UpdateAction action)
```
    Convenience method for adding an update action to the workspace's action list (the sequence of actions invoked on each iteration of the workspace).
    
    Parameters:
    
    action - new action

Class Workspace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Workspace

Method Detail

addListener

removeListener

coupleOneToMany

coupleOneToOne

addWorkspaceComponent

removeWorkspaceComponent

updateStopped

iterate

iterate

iterate

iterate

run

stop

clearWorkspace

removeAllComponents

changesExist

setWorkspaceChanged

getCurrentDirectory

setCurrentDirectory

getCurrentFile

setCurrentFile

getComponentList

getComponent

getCoupling

setTaskSynchronizationManager

syncOnAllComponents

syncRest

getCouplingManager

toString

addCoupling

removeCoupling

getComponentList

getTime

getSavedTime

resetTime

getUpdater

getUpdateDelay

setUpdateDelay

preSerializationInit

openWorkspace

addUpdateAction