Package org.neuroml1.model.channel

Enum DeprecatedIonRole

java.lang.Object

java.lang.Enum<DeprecatedIonRole>

org.neuroml1.model.channel.DeprecatedIonRole

All Implemented Interfaces:

Serializable, Comparable<DeprecatedIonRole>, java.lang.constant.Constable

public enum DeprecatedIonRole
extends Enum<DeprecatedIonRole>

Java class for Deprecated_IonRole.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="Deprecated_IonRole">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="PermeatedSubstance"/>
     <enumeration value="PermeatedSubstanceFixedRevPot"/>
     <enumeration value="ModulatingSubstance"/>
     <enumeration value="SignallingSubstance"/>
   </restriction>
 </simpleType>
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODULATING_SUBSTANCE	Concentration of ion/substance modulates dynamics/rate equations of channel, e.g.
PERMEATED_SUBSTANCE	Ion passes through the channel, e.g.
PERMEATED_SUBSTANCE_FIXED_REV_POT	WARNING: Ion passes through the channel, but the reversal potential of the ion isn't altered.
SIGNALLING_SUBSTANCE	Ion/substance is involved in internal signalling in the cell and the mechanism can alter its concentration, e.g.

Method Summary

Modifier and Type	Method	Description
static DeprecatedIonRole	fromValue(String v)
String	value()
static DeprecatedIonRole	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DeprecatedIonRole[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PERMEATED_SUBSTANCE

public static final DeprecatedIonRole PERMEATED_SUBSTANCE

Ion passes through the channel, e.g. Na ions permeate through an "Na Channel"

PERMEATED_SUBSTANCE_FIXED_REV_POT

public static final DeprecatedIonRole PERMEATED_SUBSTANCE_FIXED_REV_POT

WARNING: Ion passes through the channel, but the reversal potential of the ion isn't altered. This case is to cope with existing models which (rightly or wrongly) have calcium channels which lead to a calcium current, but which have a fixed reversal potential (Traub et. al 2003 CaL, Maex, De Schutter 1998 CaHVA). Be sure that this is the correct intended behaviour of the channel before using this IonRole.

MODULATING_SUBSTANCE

public static final DeprecatedIonRole MODULATING_SUBSTANCE

Concentration of ion/substance modulates dynamics/rate equations of channel, e.g. Ca dependent K channel, K permeates, but the rate is dependent on concentration of internal Ca

SIGNALLING_SUBSTANCE

public static final DeprecatedIonRole SIGNALLING_SUBSTANCE

Ion/substance is involved in internal signalling in the cell and the mechanism can alter its concentration, e.g. exponentially decaying Ca pool

Method Details

values

public static DeprecatedIonRole[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeprecatedIonRole valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static DeprecatedIonRole fromValue(String v)