Package org.neuroml.model

Class SineGenerator

java.lang.Object
org.neuroml.model.BaseWithoutId
org.neuroml.model.Base
org.neuroml.model.Standalone
org.neuroml.model.SineGenerator
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.ToString2
public class SineGenerator extends Standalone implements org.jvnet.jaxb2_commons.lang.ToString2
Generates a sinusoidally varying current after a time **delay,** for a fixed **duration.** The **period** and maximum **amplitude** of the current can be set as well as the **phase** at which to start. Scaled by **weight,** if set \n :param phase: Phase ( between 0 and 2*pi ) at which to start the varying current ( i. e. at time given by delay ) :type phase: none :param delay: Delay before change in current. Current is zero prior to this. :type delay: time :param duration: Duration for holding current at amplitude. Current is zero after delay + duration. :type duration: time :param amplitude: Maximum amplitude of current :type amplitude: current :param period: Time period of oscillation :type period: time

Java class for SineGenerator complex type.

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

 <complexType name="SineGenerator">
   <complexContent>
     <extension base="{http://www.neuroml.org/schema/neuroml2}Standalone">
       <attribute name="delay" use="required" type="{http://www.neuroml.org/schema/neuroml2}Nml2Quantity_time" />
       <attribute name="phase" use="required" type="{http://www.neuroml.org/schema/neuroml2}Nml2Quantity_none" />
       <attribute name="duration" use="required" type="{http://www.neuroml.org/schema/neuroml2}Nml2Quantity_time" />
       <attribute name="amplitude" use="required" type="{http://www.neuroml.org/schema/neuroml2}Nml2Quantity_current" />
       <attribute name="period" use="required" type="{http://www.neuroml.org/schema/neuroml2}Nml2Quantity_time" />
     </extension>
   </complexContent>
 </complexType>

  • Field Details

    • delay

      protected String delay

    • phase

      protected String phase

    • duration

      protected String duration

    • amplitude

      protected String amplitude

    • period

      protected String period

  • Constructor Details

    • SineGenerator

      public SineGenerator()

  • Method Details

    • getDelay

      public String getDelay()
      Gets the value of the delay property.
      Returns:
      possible object is String

    • setDelay

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

    • getPhase

      public String getPhase()
      Gets the value of the phase property.
      Returns:
      possible object is String

    • setPhase

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

    • getDuration

      public String getDuration()
      Gets the value of the duration property.
      Returns:
      possible object is String

    • setDuration

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

    • getAmplitude

      public String getAmplitude()
      Gets the value of the amplitude property.
      Returns:
      possible object is String

    • setAmplitude

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

    • getPeriod

      public String getPeriod()
      Gets the value of the period property.
      Returns:
      possible object is String

    • setPeriod

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

    • toString

      public String toString()
      Overrides:
      toString in class Standalone

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

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