• Docs
  • Learn
  • Community
    Search Results for

      Show / Hide Table of Contents

      Class Timer

      Represents an operator that generates an observable sequence that periodically produces a value after the specified initial relative due time has elapsed.

      Marble diagram

      Timer can either generate a single value, if Period is not specified, or an infinite sequence of values emitted periodically. The first value of Timer is emitted after the specified DueTime.

      Warning

      The value of the DueTime and Period properties cannot be modified after the observable sequence has initialized. If dynamic configuration is necessary, make sure that all properties are immediately configured using property mapping operators.

      Inheritance
      Object
      Source<Int64>
      Timer
      Inherited Members
      Object.ToString()
      Object.Equals(Object)
      Object.Equals(Object, Object)
      Object.ReferenceEquals(Object, Object)
      Object.GetHashCode()
      Object.GetType()
      Object.MemberwiseClone()
      Namespace: Bonsai.Reactive
      Assembly: Bonsai.Core.dll
      Syntax
      public class Timer : Source<long>

      Properties

      | Improve this Doc View Source

      DueTime

      Gets or sets the relative time at which to produce the first value. If this value is less than or equal to Zero, the timer will fire as soon as possible.

      Declaration
      public TimeSpan DueTime { get; set; }
      Property Value
      Type Description
      TimeSpan
      | Improve this Doc View Source

      DueTimeXml

      Gets or sets an XML representation of the due time for serialization.

      Declaration
      [Browsable(false)]
      public string DueTimeXml { get; set; }
      Property Value
      Type Description
      String
      | Improve this Doc View Source

      Period

      Gets or sets the period to produce subsequent values. If this value is equal to Zero the timer will recur as fast as possible.

      Declaration
      public TimeSpan Period { get; set; }
      Property Value
      Type Description
      TimeSpan
      | Improve this Doc View Source

      PeriodXml

      Gets or sets an XML representation of the period for serialization.

      Declaration
      [Browsable(false)]
      public string PeriodXml { get; set; }
      Property Value
      Type Description
      String

      Methods

      | Improve this Doc View Source

      Generate()

      Generates an observable sequence that periodically produces a value after the specified initial relative due time has elapsed.

      Declaration
      public override IObservable<long> Generate()
      Returns
      Type Description
      IObservable<Int64>

      An observable sequence of integer values counting how many times the timer has fired.

      Overrides
      Bonsai.Source<System.Int64>.Generate()
      • Improve this Doc
      • View Source
      In This Article
      Back to top Generated by DocFX