Package mgui.models.dynamic

Interface DynamicModelEnvironmentSensor

All Superinterfaces:

CleanableObject, InterfaceObject, NamedObject, TreeObject

All Known Implementing Classes:

AbstractCorticalInput, AbstractEnvironmentDataSource, AbstractSensoryNeuron, SimpleCorticalInput, SimpleEnvironmentInputDataSource, SimpleEnvironmentObservableDataSource, SimpleSensoryNeuron

public interface DynamicModelEnvironmentSensor
extends InterfaceObject

Acts as a sensor for a model environment, which responds to state change events via the stimulate method.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Method Summary

Modifier and Type	Method	Description
int	getIndex()
java.lang.String	getName()	Gets the name for this object.
void	reset()
void	setIndex(int i)
boolean	stimulate(DynamicModelEnvironmentEvent e)	Notifies this sensor that the environment has changed.

Methods inherited from interface mgui.interfaces.util.CleanableObject

clean

Methods inherited from interface mgui.interfaces.InterfaceObject

destroy, isDestroyed

Methods inherited from interface mgui.interfaces.NamedObject

setName

Methods inherited from interface mgui.interfaces.trees.TreeObject

getTreeLabel, issueTreeNode, setTreeNode

Method Details

stimulate

boolean stimulate(DynamicModelEnvironmentEvent e)

Notifies this sensor that the environment has changed.

Parameters:

e -

Returns:

setIndex

void setIndex(int i)

getIndex

int getIndex()

getName

java.lang.String getName()

Description copied from interface: NamedObject

Gets the name for this object.

Specified by:

getName in interface NamedObject

Returns:

reset

void reset()