HodgkinHuxleyRule (Simbrain API)

java.lang.Object
- org.simbrain.network.core.NeuronUpdateRule
- - org.simbrain.network.core.SpikingNeuronUpdateRule
  - - org.simbrain.network.neuron_update_rules.HodgkinHuxleyRule

```
public class HodgkinHuxleyRule
extends SpikingNeuronUpdateRule
```
Hodgkin-Huxley Neuron. Adapted from software written by Anthony Fodor, with help from Jonathan Vickrey. TODO: No implementation.

Nested Class Summary
- Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule
  NeuronUpdateRule.InputType

Field Summary

Fields
Modifier and Type Field and Description

(package private) float vClampValue
- Fields inherited from class org.simbrain.network.core.NeuronUpdateRule
  DEFAULT_INCREMENT, increment, inputType

Fields
Modifier and Type	Field and Description
`(package private) float`	`vClampValue`

Constructor Summary

Constructors
Constructor and Description

HodgkinHuxleyRule()

Constructors
Constructor and Description
`HodgkinHuxleyRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`convertV(float voltage)` Converts a voltage from the modern convention to the convention used by the program.
`NeuronUpdateRule`	`deepCopy()` Returns a deep copy of the update rule.
`double`	`get_k_current()`
`double`	`get_m3h()`
`double`	`get_n4()`
`double`	`get_na_current()`
`(package private) float`	`get_vClampValue()`
`double`	`getCm()`
`java.lang.String`	`getDescription()` Returns a brief description of this update rule.
`double`	`getDt()`
`float`	`getEk()`
`double`	`getElapsedTime()`
`float`	`getEna()`
`double`	`getH()`
`double`	`getM()`
`double`	`getN()`
`float`	`getPerKChannels()`
`float`	`getPerNaChannels()`
`double`	`getTemp()`
`Network.TimeType`	`getTimeType()` Returns the type of time update (discrete or continuous) associated with this neuron.
`boolean`	`getVClampOn()`
`void`	`init(Neuron neuron)`
`void`	`resetElapsedTime()`
`(package private) void`	`set_vClampValue(float vClampValue)`
`void`	`setCm(double inCm)`
`void`	`setDt(double inDt)`
`void`	`setEk(float Ek)`
`void`	`setEna(float Ena)`
`void`	`setPerKChannels(float perKChannels)`
`void`	`setPerNaChannels(float perNaChannels)`
`void`	`setTemp(double temp)`
`void`	`setVClampOn(boolean vClampOn)`
`void`	`update(Neuron neuron)` Apply the update rule.

Methods inherited from class org.simbrain.network.core.SpikingNeuronUpdateRule
clear, getLastSpikeTime, isSpikingNeuron, setHasSpiked, setLastSpikeTime

Methods inherited from class org.simbrain.network.core.NeuronUpdateRule
contextualDecrement, contextualIncrement, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getRandomValue, getToolTipText, incrementActivation, isSkipsSynapticUpdates, setIncrement, setInputType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - vClampValue
```
float vClampValue
```
- Constructor Detail
  - HodgkinHuxleyRule
```
public HodgkinHuxleyRule()
```
- Method Detail
  - update
```
public void update(Neuron neuron)
```
    Apply the update rule.
    
    Specified by:
    
    update in class SpikingNeuronUpdateRule
    
    Parameters:
    
    neuron -
  - init
```
public void init(Neuron neuron)
```
    Parameters:
    
    neuron -
  - getTimeType
```
public Network.TimeType getTimeType()
```
    Returns the type of time update (discrete or continuous) associated with this neuron.
    
    Overrides:
    
    getTimeType in class SpikingNeuronUpdateRule
    
    Returns:
    
    the time type
  - get_n4
```
public double get_n4()
```
  - get_m3h
```
public double get_m3h()
```
  - getEna
```
public float getEna()
```
  - getEk
```
public float getEk()
```
  - setEna
```
public void setEna(float Ena)
```
  - setEk
```
public void setEk(float Ek)
```
  - get_na_current
```
public double get_na_current()
```
  - get_k_current
```
public double get_k_current()
```
  - setPerNaChannels
```
public void setPerNaChannels(float perNaChannels)
```
  - getPerNaChannels
```
public float getPerNaChannels()
```
  - setPerKChannels
```
public void setPerKChannels(float perKChannels)
```
  - getPerKChannels
```
public float getPerKChannels()
```
  - setCm
```
public void setCm(double inCm)
```
  - getCm
```
public double getCm()
```
  - setDt
```
public void setDt(double inDt)
```
  - getDt
```
public double getDt()
```
  - getElapsedTime
```
public double getElapsedTime()
```
  - resetElapsedTime
```
public void resetElapsedTime()
```
  - getN
```
public double getN()
```
  - getM
```
public double getM()
```
  - getH
```
public double getH()
```
  - convertV
```
public float convertV(float voltage)
```
    Converts a voltage from the modern convention to the convention used by the program.
    
    Parameters:
    
    voltage -
    
    Returns:
  - getVClampOn
```
public boolean getVClampOn()
```
  - setVClampOn
```
public void setVClampOn(boolean vClampOn)
```
  - get_vClampValue
```
float get_vClampValue()
```
  - set_vClampValue
```
void set_vClampValue(float vClampValue)
```
  - getTemp
```
public double getTemp()
```
  - setTemp
```
public void setTemp(double temp)
```
  - deepCopy
```
public NeuronUpdateRule deepCopy()
```
    Description copied from class: NeuronUpdateRule
    
    Returns a deep copy of the update rule.
    
    Specified by:
    
    deepCopy in class NeuronUpdateRule
    
    Returns:
    
    Duplicated update rule
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from class: NeuronUpdateRule
    
    Returns a brief description of this update rule. Used in combo boxes in the GUI.
    
    Specified by:
    
    getDescription in class NeuronUpdateRule
    
    Returns:
    
    the description.

Class HodgkinHuxleyRule

Nested Class Summary

Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule

Field Summary

Fields inherited from class org.simbrain.network.core.NeuronUpdateRule

Constructor Summary

Method Summary

Methods inherited from class org.simbrain.network.core.SpikingNeuronUpdateRule

Methods inherited from class org.simbrain.network.core.NeuronUpdateRule

Methods inherited from class java.lang.Object

Field Detail

vClampValue

Constructor Detail

HodgkinHuxleyRule

Method Detail

update

init

getTimeType

get_n4

get_m3h

getEna

getEk

setEna

setEk

get_na_current

get_k_current

setPerNaChannels

getPerNaChannels

setPerKChannels

getPerKChannels

setCm

getCm

setDt

getDt

getElapsedTime

resetElapsedTime

getN

getM

getH

convertV

getVClampOn

setVClampOn

get_vClampValue

set_vClampValue

getTemp

setTemp

deepCopy

getDescription