|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Probe
Reads state variables from Probeable objects (eg membrane potential from a Neuron). Collected data can be displayed during a simluation or kept for plotting afterwards.
| Method Summary | |
|---|---|
void |
collect(float time)
Processes new data. |
void |
connect(Probeable target,
java.lang.String stateName,
boolean record)
|
void |
connect(java.lang.String ensembleName,
Probeable target,
java.lang.String stateName,
boolean record)
|
TimeSeries |
getData()
|
java.lang.String |
getEnsembleName()
|
java.lang.String |
getStateName()
|
Probeable |
getTarget()
|
boolean |
isInEnsemble()
|
void |
reset()
Clears collected data. |
void |
setSamplingRate(float rate)
|
| Method Detail |
|---|
void connect(java.lang.String ensembleName,
Probeable target,
java.lang.String stateName,
boolean record)
throws SimulationException
ensembleName - Name of the Ensemble the target object belongs to. Null, if
the target is a top-level node.target - The object about which state history is to be collectedstateName - The name of the state variable to collectrecord - If true, getData() returns history since last connect() or
reset(), otherwise getData() returns most recent sample
SimulationException - if the given target does not have the given state
void connect(Probeable target,
java.lang.String stateName,
boolean record)
throws SimulationException
target - The object about which state history is to be collectedstateName - The name of the state variable to collectrecord - If true, getData() returns history since last connect() or
reset(), otherwise getData() returns most recent sample
SimulationException - if the given target does not have the given statevoid reset()
void collect(float time)
void setSamplingRate(float rate)
rate - Rate in samples per second. The default is one sample per network time step, and it is
not possible to sample faster than this (specifying a higher sampling rate has no effect).TimeSeries getData()
Probeable getTarget()
java.lang.String getStateName()
boolean isInEnsemble()
java.lang.String getEnsembleName()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||