Make period nullable and clarify documentation

bonsai-rx · Aug 6, 2024 · 8582642 · 8582642
1 parent 2295035
commit 8582642
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/Bonsai.Core/Reactive/Timer.cs b/Bonsai.Core/Reactive/Timer.cs
@@ -26,12 +26,12 @@ public class Timer : Source<long>
         public TimeSpan DueTime { get; set; }
 
         /// <summary>
-        /// Gets or sets the period to produce subsequent values. If this value is equal
-        /// to <see cref="TimeSpan.Zero"/> the timer will recur as fast as possible.
+        /// Gets or sets the period to produce subsequent values. If this value is not specified
+        /// or equal to <see cref="TimeSpan.Zero"/> the timer will only fire once.
         /// </summary>
         [XmlIgnore]
-        [Description("The period to produce subsequent values. If this value is equal to zero the timer will recur as fast as possible.")]
-        public TimeSpan Period { get; set; }
+        [Description("The period to produce subsequent values. If this value is not specified or equal to zero the timer will only fire once.")]
+        public TimeSpan? Period { get; set; }
 
         /// <summary>
         /// Gets or sets an XML representation of the due time for serialization.
@@ -53,8 +53,8 @@ public string DueTimeXml
         [EditorBrowsable(EditorBrowsableState.Never)]
         public string PeriodXml
         {
-            get { return XmlConvert.ToString(Period); }
-            set { Period = XmlConvert.ToTimeSpan(value); }
+            get { return Period > TimeSpan.Zero ? XmlConvert.ToString(Period.GetValueOrDefault()) : null; }
+            set { Period = string.IsNullOrEmpty(value) ? null : XmlConvert.ToTimeSpan(value); }
         }
 
         /// <summary>
@@ -69,7 +69,7 @@ public override IObservable<long> Generate()
         {
             var period = Period;
             return period > TimeSpan.Zero
-                ? Observable.Timer(DueTime, period)
+                ? Observable.Timer(DueTime, period.GetValueOrDefault())
                 : Observable.Timer(DueTime);
         }
     }

diff --git a/Bonsai.Shaders/Timer.cs b/Bonsai.Shaders/Timer.cs
@@ -29,10 +29,10 @@ public class Timer : Source<long>
 
         /// <summary>
         /// Gets or sets the period to produce subsequent values. If this value
-        /// is undefined or equal to zero the timer will only fire once.
+        /// is not specified or equal to zero the timer will only fire once.
         /// </summary>
         [XmlIgnore]
-        [Description("The period to produce subsequent values. If this value is equal to zero the timer will recur as fast as possible.")]
+        [Description("The period to produce subsequent values. If this value is not specified or equal to zero the timer will only fire once.")]
         public TimeSpan? Period { get; set; }
 
         /// <summary>