public interface Probe
Modifier and Type | Method and Description |
---|---|
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() |
ProbeTask |
getProbeTask() |
java.lang.String |
getStateName() |
Probeable |
getTarget() |
boolean |
isInEnsemble() |
void |
reset()
Clears collected data.
|
void |
setSamplingRate(float rate) |
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 sampleSimulationException
- if the given target does not have the given statevoid 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 sampleSimulationException
- 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()
ProbeTask getProbeTask()