neuroml.channel
Class Ion

java.lang.Object
  neuroml.channel.Ion

public class Ion
extends java.lang.Object

Definition of an ion which is involved in this channel mechanism

Java class for Ion complex type.

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

 <complexType name="Ion">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <group ref="{http://morphml.org/metadata/schema}metadata"/>
       <attribute name="charge" use="required" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" />
       <attribute name="default_erev" type="{http://morphml.org/biophysics/schema}ReversalPotentialValue" />
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="role" type="{http://morphml.org/channelml/schema}IonRole" default="PermeatedSubstance" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected Annotation	annotation
protected java.math.BigInteger	charge
protected java.lang.Double	defaultErev
protected java.util.List<java.lang.String>	group
protected java.lang.String	name
protected java.lang.String	notes
protected Properties	properties
protected IonRole	role

Constructor Summary

Ion()

Method Summary

Annotation	getAnnotation() Gets the value of the annotation property.
java.math.BigInteger	getCharge() Gets the value of the charge property.
java.lang.Double	getDefaultErev() Gets the value of the defaultErev property.
java.util.List<java.lang.String>	getGroup() Gets the value of the group property.
java.lang.String	getName() Gets the value of the name property.
java.lang.String	getNotes() Gets the value of the notes property.
Properties	getProperties() Gets the value of the properties property.
IonRole	getRole() Gets the value of the role property.
void	setAnnotation(Annotation value) Sets the value of the annotation property.
void	setCharge(java.math.BigInteger value) Sets the value of the charge property.
void	setDefaultErev(java.lang.Double value) Sets the value of the defaultErev property.
void	setName(java.lang.String value) Sets the value of the name property.
void	setNotes(java.lang.String value) Sets the value of the notes property.
void	setProperties(Properties value) Sets the value of the properties property.
void	setRole(IonRole value) Sets the value of the role property.

Methods inherited from class java.lang.Object

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

Field Detail

notes

protected java.lang.String notes

properties

protected Properties properties

annotation

protected Annotation annotation

group

protected java.util.List<java.lang.String> group

charge

protected java.math.BigInteger charge

defaultErev

protected java.lang.Double defaultErev

name

protected java.lang.String name

role

protected IonRole role

Constructor Detail

Ion

public Ion()

Method Detail

getNotes

public java.lang.String getNotes()

Gets the value of the notes property.

Returns:

possible object is String

setNotes

public void setNotes(java.lang.String value)

Sets the value of the notes property.

Parameters:

value - allowed object is String

getProperties

public Properties getProperties()

Gets the value of the properties property.

Returns:

possible object is Properties

setProperties

public void setProperties(Properties value)

Sets the value of the properties property.

Parameters:

value - allowed object is Properties

getAnnotation

public Annotation getAnnotation()

Gets the value of the annotation property.

Returns:

possible object is Annotation

setAnnotation

public void setAnnotation(Annotation value)

Sets the value of the annotation property.

Parameters:

value - allowed object is Annotation

getGroup

public java.util.List<java.lang.String> getGroup()

Gets the value of the group property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the group property.

For example, to add a new item, do as follows:

    getGroup().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getCharge

public java.math.BigInteger getCharge()

Gets the value of the charge property.

Returns:

possible object is BigInteger

setCharge

public void setCharge(java.math.BigInteger value)

Sets the value of the charge property.

Parameters:

value - allowed object is BigInteger

getDefaultErev

public java.lang.Double getDefaultErev()

Gets the value of the defaultErev property.

Returns:

possible object is Double

setDefaultErev

public void setDefaultErev(java.lang.Double value)

Sets the value of the defaultErev property.

Parameters:

value - allowed object is Double

getName

public java.lang.String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(java.lang.String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getRole

public IonRole getRole()

Gets the value of the role property.

Returns:

possible object is IonRole

setRole

public void setRole(IonRole value)

Sets the value of the role property.

Parameters:

value - allowed object is IonRole