ca.nengo.model

Interface Probeable

All Known Subinterfaces:

DecodableEnsemble, LinkSegmentModel, NEFEnsemble, Network, NeuralModule, SkeletalMuscle

All Known Implementing Classes:

AbstractEnsemble, ALIFSpikeGenerator, BiasTermination, CriticallyDampedMuscle, DecodableEnsembleImpl, DecodedTermination, DefaultNeuralModule, DynamicalSystemSpikeGenerator, EnsembleImpl, ExpandableSpikingNeuron, FunctionInput, GruberNeuronFactory.GruberNeuron, GruberSpikeGenerator, HillMuscle, HodgkinHuxleySpikeGenerator, IzhikevichSpikeGenerator, LIFSpikeGenerator, LinkSegmentModelImpl, NEFEnsembleImpl, NetworkArrayImpl, NetworkImpl, PlasticEnsembleImpl, PyramidalNetwork, SkeletalMuscleImpl, SpikingNeuron

public interface Probeable

An object that can be probed for a history of its state OVER THE MOST RECENT NETWORK TIME STEP. A Probeable must declare a list of state variables via the method listStates(), and is responsible for storing store a history of these state variables covering the most recent network time step (data from past time steps can be discarded).

Method Summary

Methods

Modifier and Type	Method and Description
TimeSeries	getHistory(java.lang.String stateName) Note that the units of TimeSeries' for a given state do not change over time (ie at different time steps).
java.util.Properties	listStates()

Method Detail

getHistory

TimeSeries getHistory(java.lang.String stateName)
                      throws SimulationException

Note that the units of TimeSeries' for a given state do not change over time (ie at different time steps). CAUTION: The TimeSeries should not contain a reference to any arrays that you are going to change later. The caller owns what you return.

Parameters:

stateName - A state variable name

Returns:

History of values for the named state variable. The history must cover the most recent network time step, and no more. There should be no overlap in the time points returned for different steps.

Throws:

SimulationException - if the Probeable does not have the requested state

listStates

java.util.Properties listStates()

Returns:

List of state variable names, eg "V", and associated descriptions eg "membrane potential (mV)"