Package org.neuroml.model

Class Segment

java.lang.Object
org.neuroml.model.BaseWithoutId
org.neuroml.model.BaseNonNegativeIntegerId
org.neuroml.model.Segment
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.ToString2
public class Segment extends BaseNonNegativeIntegerId implements org.jvnet.jaxb2_commons.lang.ToString2
A segment defines the smallest unit within a possibly branching structure ( **morphology** ), such as a dendrite or axon. Its **id** should be a nonnegative integer ( usually soma/root = 0 ). Its end points are given by the **proximal** and **distal** points. The **proximal** point can be omitted, usually because it is the same as a point on the **parent** segment, see **proximal** for details. **parent** specifies the parent segment. The first segment of a **cell** ( with no **parent** ) usually represents the soma. The shape is normally a cylinder ( radii of the **proximal** and **distal** equal, but positions different ) or a conical frustum ( radii and positions different ). If the x, y, x positions of the **proximal** and **distal** are equal, the segment can be interpreted as a sphere, and in this case the radii of these points must be equal. NOTE: LEMS does not yet support multicompartmental modelling, so the Dynamics here is only appropriate for single compartment modelling.

Java class for Segment complex type.

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

 <complexType name="Segment">
   <complexContent>
     <extension base="{http://www.neuroml.org/schema/neuroml2}BaseNonNegativeIntegerId">
       <sequence>
         <element name="parent" type="{http://www.neuroml.org/schema/neuroml2}SegmentParent" minOccurs="0"/>
         <element name="proximal" type="{http://www.neuroml.org/schema/neuroml2}Point3DWithDiam" minOccurs="0"/>
         <element name="distal" type="{http://www.neuroml.org/schema/neuroml2}Point3DWithDiam"/>
       </sequence>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="neuroLexId" type="{http://www.neuroml.org/schema/neuroml2}NeuroLexId" />
     </extension>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • Segment

      public Segment()

  • Method Details

    • getParent

      public SegmentParent getParent()
      Gets the value of the parent property.
      Returns:
      possible object is SegmentParent

    • setParent

      public void setParent(SegmentParent value)
      Sets the value of the parent property.
      Parameters:
      value - allowed object is SegmentParent

    • getProximal

      public Point3DWithDiam getProximal()
      Gets the value of the proximal property.
      Returns:
      possible object is Point3DWithDiam

    • setProximal

      public void setProximal(Point3DWithDiam value)
      Sets the value of the proximal property.
      Parameters:
      value - allowed object is Point3DWithDiam

    • getDistal

      public Point3DWithDiam getDistal()
      Gets the value of the distal property.
      Returns:
      possible object is Point3DWithDiam

    • setDistal

      public void setDistal(Point3DWithDiam value)
      Sets the value of the distal property.
      Parameters:
      value - allowed object is Point3DWithDiam

    • getName

      public String getName()
      Gets the value of the name property.
      Returns:
      possible object is String

    • setName

      public void setName(String value)
      Sets the value of the name property.
      Parameters:
      value - allowed object is String

    • getNeuroLexId

      public String getNeuroLexId()
      Gets the value of the neuroLexId property.
      Returns:
      possible object is String

    • setNeuroLexId

      public void setNeuroLexId(String value)
      Sets the value of the neuroLexId property.
      Parameters:
      value - allowed object is String

    • toString

      public String toString()
      Overrides:
      toString in class BaseNonNegativeIntegerId

    • append

      public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
      Specified by:
      append in interface org.jvnet.jaxb2_commons.lang.ToString2
      Overrides:
      append in class BaseNonNegativeIntegerId

    • appendFields

      public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2
      Overrides:
      appendFields in class BaseNonNegativeIntegerId