Package mgui.neuro.components.compartments

Class CompartmentalComponent

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.models.networks.components.AbstractNetworkComponent

mgui.neuro.components.AbstractNeuroComponent

mgui.neuro.components.compartments.CompartmentalComponent

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<DynamicModelComponent>, AttributeListener, AttributeObject, InterfaceObject, NamedObject, TreeObject, CleanableObject, DynamicModelComponent, TimeStepListener, Updateable

Direct Known Subclasses:

CompartmentalNeuron, NeuronalCompartmentalComponent

public abstract class CompartmentalComponent
extends AbstractNeuroComponent

Base abstract class for all components using a compartmental model.

Author:

Andrew Reid

Field Summary

Fields

Modifier and Type	Field	Description
java.util.ArrayList<AbstractCompartment>	compartments

Fields inherited from class mgui.neuro.components.AbstractNeuroComponent

attributes, clock, connections, events, hasSubComponents, id, listeners, solver, updated

Fields inherited from class mgui.interfaces.AbstractInterfaceObject

isDestroyed, tree_nodes

Constructor Summary

Constructors

Constructor	Description
CompartmentalComponent()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
protected boolean	executeEvent(DynamicModelEvent e)
int	getN()
protected void	init()
abstract void	setCompartments()	Set/reset list of compartments to size N
void	setN(int n)
void	timeElapsed(double step)
abstract void	transmit(AbstractCompartment c1, AbstractCompartment c2)	Transmit signals between compartments; should update appropriate state and/or temporary variables.

Methods inherited from class mgui.neuro.components.AbstractNeuroComponent

addConnection, addEvent, addListener, addToEngine, attributeUpdated, compareTo, executeEvents, fireListeners, fireListeners, getAttribute, getAttributes, getConnections, getDelay, getID, getName, getODESolver, getRate, getSolver, getSubComponents, hasSubComponents, removeConnection, removeListener, reset, resetClock, setAttribute, setAttributes, setDelay, setID, setID, setName, setODESolver, setSolver, setSolver, updateComponent, updateFromClock

Methods inherited from class mgui.models.networks.components.AbstractNetworkComponent

getAttributeValue

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, destroy, getTreeLabel, isDestroyed, issueTreeNode, setTreeNode, updateTreeNodes

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface mgui.interfaces.util.CleanableObject

clean

Methods inherited from interface mgui.interfaces.InterfaceObject

destroy, isDestroyed

Methods inherited from interface mgui.interfaces.trees.TreeObject

getTreeLabel, issueTreeNode, setTreeNode

Field Details

compartments

public java.util.ArrayList<AbstractCompartment> compartments

Constructor Details

CompartmentalComponent

public CompartmentalComponent()

Method Details

executeEvent

protected boolean executeEvent(DynamicModelEvent e)
                        throws NeuroException

Overrides:

executeEvent in class AbstractNeuroComponent

Throws:

NeuroException

init

protected void init()

Overrides:

init in class AbstractNeuroComponent

timeElapsed

public void timeElapsed(double step)

Specified by:

timeElapsed in interface TimeStepListener

Overrides:

timeElapsed in class AbstractNeuroComponent

transmit

public abstract void transmit(AbstractCompartment c1,
AbstractCompartment c2)
                       throws NeuroException

Transmit signals between compartments; should update appropriate state and/or temporary variables.

Throws:

NeuroException

setN

public void setN(int n)

setCompartments

public abstract void setCompartments()

Set/reset list of compartments to size N

getN

public int getN()

clone

public java.lang.Object clone()

Specified by:

clone in interface DynamicModelComponent

Specified by:

clone in class AbstractNeuroComponent