|
The Physiologist's Friend Simulation API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectch.unizh.ini.friend.simulation.SimulationSetup
public class SimulationSetup
A collection of references to objects that together describe the current state of the simulation.
The collection of fidicial cells (cells that can monitored) is built by SimulationSetupFactory
.
These cells are entered into a HsshMap
. You can get a particular cell by the key name it was stored under, using
getOutputCell(java.lang.String)
, or you can get at the entire list with getOutputCells()
.
You can set the cell to monitor with setMonitoredCell(java.lang.String)
.
Nested Class Summary | |
---|---|
class |
SimulationSetup.NoSuchCellException
indicates we tried to monitor a nonexistent cell |
Field Summary | |
---|---|
protected ServesOutput |
monitoredCell
the monitored cell. |
protected Map |
monitors
Monitors that can be configured to listen to a specific cell. |
protected Collection |
offGanglions
the off-type ganglion cells |
protected Collection |
onGanglions
the on-type ganglion cells |
protected Map |
outputCells
The cells that can be monitored. |
protected ArrayList |
receptorShapes
The shapes of the photoreceptors. |
protected List |
simulatedCells
The cells that are simulated. |
protected SimulationTask |
simulation
The simulation. |
protected String |
startingCellName
The cell which is monitored first. |
protected Stimulus |
stimulus
The stimulus. |
Constructor Summary | |
---|---|
SimulationSetup()
|
Method Summary | |
---|---|
AcceptsInput |
getMonitor(String key)
returns a particlar monitor by its key. |
ServesOutput |
getMonitoredCell()
returns the monitored cell |
Map |
getMonitors()
Returns the monitors that are currently registered. |
String |
getName()
|
Collection |
getOffGanglions()
Return the retinal ganglion off-type cells |
Collection |
getOnGanglions()
Return the retinal ganglion on-type cells |
Object |
getOutputCell(String key)
returns a particlar output cell by its key. |
Map |
getOutputCells()
Returns the cells that can be monitored (listened to). |
ArrayList |
getReceptorShapes()
Returns the shapes of the photoreceptors. |
List |
getSimulatedCells()
Returns the cells that are simulated |
SimulationTask |
getSimulation()
Returns the current simulation instance. |
String |
getStartingCellName()
Gets the starting cell name. |
Stimulus |
getStimulus()
Returns the current stimulus instance. |
void |
putMonitor(String key,
AcceptsInput monitor)
put a an object into the monitors map. |
void |
putOutputCell(String key,
Object cell)
put a an object into the output cells map. |
void |
setMonitoredCell(ServesOutput cell)
set the monitored cell in the simulation directly. |
void |
setMonitoredCell(String key)
set the monitored cell in the simulation using the String key. |
void |
setMonitors(Map monitors)
Sets the Map of monitors. |
void |
setName(String n)
|
void |
setOffGanglions(Collection c)
|
void |
setOnGanglions(Collection c)
|
void |
setOutputCells(Map cells)
Sets the cells that can be monitored (listened to). |
void |
setReceptorShapes(ArrayList receptorShapes)
Sets the shapes of the photoreceptors. |
void |
setSimulatedCells(List cells)
Sets the cells that are simulated |
void |
setSimulation(SimulationTask simulation)
Sets the current simulation instance. |
void |
setStartingCellName(String startingCellName)
Sets the starting cell Name. |
void |
setStimulus(Stimulus stimulus)
Sets the current stimulus instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected SimulationTask simulation
protected Stimulus stimulus
protected List simulatedCells
SimulationStep
.
It is an ArrayList.
outputCells
protected Map outputCells
see #setOutputCells
protected Collection onGanglions
protected Collection offGanglions
protected Map monitors
protected ArrayList receptorShapes
protected ServesOutput monitoredCell
setMonitoredCell(java.lang.String)
protected String startingCellName
Constructor Detail |
---|
public SimulationSetup()
Method Detail |
---|
public String getName()
public void setName(String n)
n
- the namepublic SimulationTask getSimulation()
public void setSimulation(SimulationTask simulation)
simulation
- The new simulation.public Stimulus getStimulus()
public void setStimulus(Stimulus stimulus)
stimulus
- The new stimulus.public Map getOutputCells()
public void setOutputCells(Map cells)
cells
- The cells.public Object getOutputCell(String key)
key
- the key the cell was stored in the map by
public List getSimulatedCells()
public void setSimulatedCells(List cells)
cells
- The cells.public Collection getOnGanglions()
public Collection getOffGanglions()
public void setOnGanglions(Collection c)
public void setOffGanglions(Collection c)
public void putOutputCell(String key, Object cell)
key
- the storage keycell
- the cell to storepublic Map getMonitors()
public void setMonitors(Map monitors)
getOutputCells()
.
monitors
- The monitors.public AcceptsInput getMonitor(String key)
key
- the key the monitor was stored in the map bysetMonitors(java.util.Map)
public void putMonitor(String key, AcceptsInput monitor)
key
- the storage keymonitor
- the monitor to storesetMonitors(java.util.Map)
public ArrayList getReceptorShapes()
public void setReceptorShapes(ArrayList receptorShapes)
receptorShapes
- The shapes.public void setMonitoredCell(String key)
key
- The key by which the cell was put
into the collection of
fiducial output cells
.
SimulationSetup.NoSuchCellException
- if you try to monitor a cell that doesn't existsetMonitoredCell(ServesOutput)
public void setMonitoredCell(ServesOutput cell)
AudioOutput
and visually in the ActivityMeter
.
cell
- The key by which the cell was put
into the collection of
fiducial output cells
.setMonitoredCell(String)
public ServesOutput getMonitoredCell()
public String getStartingCellName()
public void setStartingCellName(String startingCellName)
startingCellName
- The starting cell name to set
|
http://www.ini.unizh.ch/~tobi/friend | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |