Package org.neuroml.model

Class SegmentGroup

java.lang.Object
org.neuroml.model.BaseWithoutId
org.neuroml.model.Base
org.neuroml.model.SegmentGroup
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.ToString2
public class SegmentGroup extends Base implements org.jvnet.jaxb2_commons.lang.ToString2
A method to describe a group of **segment** s in a **morphology** , e. g. soma_group, dendrite_group, axon_group. While a name is useful to describe the group, the **neuroLexId** attribute can be used to explicitly specify the meaning of the group, e. g. sao1044911821 for 'Neuronal Cell Body', sao1211023249 for 'Dendrite'. The **segment** s in this group can be specified as: a list of individual **member** segments; a **path** , all of the segments along which should be included; a **subTree** of the **cell** to include; other segmentGroups to **include** ( so all segments from those get included here ). An **inhomogeneousParameter** can be defined on the region of the cell specified by this group ( see **variableParameter** for usage ).

Java class for SegmentGroup complex type.

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

 <complexType name="SegmentGroup">
   <complexContent>
     <extension base="{http://www.neuroml.org/schema/neuroml2}Base">
       <sequence>
         <element name="notes" type="{http://www.neuroml.org/schema/neuroml2}Notes" minOccurs="0"/>
         <element name="property" type="{http://www.neuroml.org/schema/neuroml2}Property" maxOccurs="unbounded" minOccurs="0"/>
         <element name="annotation" type="{http://www.neuroml.org/schema/neuroml2}Annotation" minOccurs="0"/>
         <element name="member" type="{http://www.neuroml.org/schema/neuroml2}Member" maxOccurs="unbounded" minOccurs="0"/>
         <element name="include" type="{http://www.neuroml.org/schema/neuroml2}Include" maxOccurs="unbounded" minOccurs="0"/>
         <element name="path" type="{http://www.neuroml.org/schema/neuroml2}Path" maxOccurs="unbounded" minOccurs="0"/>
         <element name="subTree" type="{http://www.neuroml.org/schema/neuroml2}SubTree" maxOccurs="unbounded" minOccurs="0"/>
         <element name="inhomogeneousParameter" type="{http://www.neuroml.org/schema/neuroml2}InhomogeneousParameter" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="neuroLexId" type="{http://www.neuroml.org/schema/neuroml2}NeuroLexId" />
     </extension>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • SegmentGroup

      public SegmentGroup()

  • Method Details

    • getNotes

      public String getNotes()
      Gets the value of the notes property.
      Returns:
      possible object is String

    • setNotes

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

    • getProperty

      public List<Property> getProperty()
      Gets the value of the property 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 property property.

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

          getProperty().add(newItem);

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

    • 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

    • getMember

      public List<Member> getMember()
      Gets the value of the member 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 member property.

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

          getMember().add(newItem);

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

    • getInclude

      public List<Include> getInclude()
      Gets the value of the include 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 include property.

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

          getInclude().add(newItem);

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

    • getPath

      public List<Path> getPath()
      Gets the value of the path 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 path property.

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

          getPath().add(newItem);

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

    • getSubTree

      public List<SubTree> getSubTree()
      Gets the value of the subTree 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 subTree property.

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

          getSubTree().add(newItem);

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

    • getInhomogeneousParameter

      public List<InhomogeneousParameter> getInhomogeneousParameter()
      Gets the value of the inhomogeneousParameter 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 inhomogeneousParameter property.

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

          getInhomogeneousParameter().add(newItem);

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

    • 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 Base

    • 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 Base

    • 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 Base