Merge pull request #466 from open-ephys/issue-460

Rename OutputClockData as OutputClockHardwareParameters

Author: jonnew

OpenEphys.Onix1/Bno055DataFrame.cs

@@ -14,7 +14,7 @@ namespace OpenEphys.Onix1
     /// href="https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bno055-ds000.pdf">datasheet</a>)
     /// . If the chip is in NDOF mode and is calibrated, orientation measurements (Quaternion, Euler Angles,
     /// and Gravity Vector) are absolute ("allocentric") and referenced to the gravity vector and Earth's
-    /// magnetic field. Specifically, if the chip's axes are oriented such that Y points towords magnetic
+    /// magnetic field. Specifically, if the chip's axes are oriented such that Y points towards magnetic
     /// north, X points towards magnetic east, and Z points opposite the gravity vector, the orientation
     /// reading will be null (i.e. Quaternion: X = 0, Y = 0, Z = 0, W = 1; Euler Angles: Yaw = 0, Pitch = 0,
     /// and Roll = 0 degrees; Gravity: X = 0, Y = 0, Z = 9.8 m/s^2). Linear acceleration readings are always

OpenEphys.Onix1/ConfigureOutputClock.cs

@@ -57,7 +57,7 @@ public bool ClockGate
         /// integer multiple of the <see cref="ContextTask.AcquisitionClockHz">Acquisition Clock</see>
         /// frequency. Therefore, the true clock frequency will be set to a value that is as close as possible
         /// to the requested setting while respecting this constraint. The value as actualized in hardware is
-        /// reported by <see cref="OutputClockData"/>.
+        /// reported by <see cref="OutputClockHardwareParameters"/>.
         /// </remarks>
         [Range(0.1, 10e6)]
         [Category(ConfigurationCategory)]
@@ -79,7 +79,7 @@ public double Frequency
         /// multiple of the <see cref="ContextTask.AcquisitionClockHz">Acquisition Clock</see> frequency.
         /// Therefore, the true duty cycle will be set to a value that is as close as possible to the
         /// requested setting while respecting this constraint. The value as actualized in hardware is
-        /// reported by <see cref="OutputClockData"/>.
+        /// reported by <see cref="OutputClockHardwareParameters"/>.
         /// </remarks>
         [Range(10, 90)]
         [Editor(DesignTypes.SliderEditor, typeof(UITypeEditor))]
@@ -110,7 +110,7 @@ public double DutyCycle
         /// cref="ContextTask.AcquisitionClockHz">Acquisition Clock</see> frequency. Therefore, the true delay
         /// cycle will be set to a value that is as close as possible to the requested setting while
         /// respecting this constraint. The value as actualized in hardware is reported by <see
-        /// cref="OutputClockData"/>.
+        /// cref="OutputClockHardwareParameters"/>.
         /// </para>
         /// </remarks>
         [Category(ConfigurationCategory)]

OpenEphys.Onix1/OutputClockData.cs renamed to OpenEphys.Onix1/OutputClockHardwareParameters.cs

@@ -7,14 +7,15 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// Produces a sequence with a single element containing the output clock's exact hardware parameters for each subscription.
+    /// Produces a sequence with a single element containing the output clock's exact hardware parameters for
+    /// each subscription.
     /// </summary>
     /// <remarks>
     /// This data IO operator must be linked to an appropriate configuration, such as a <see
     /// cref="ConfigureOutputClock"/>, using a shared <c>DeviceName</c>.
     /// </remarks>
     [Description("Produces a sequence with a single element containing the output clock's hardware parameters for each subscription.")]
-    public class OutputClockData : Source<OutputClockParameters>
+    public class OutputClockHardwareParameters : Source<OutputClockParameters>
     {
         /// <inheritdoc cref = "SingleDeviceFactory.DeviceName"/>
         [TypeConverter(typeof(OutputClock.NameConverter))]
@@ -36,4 +37,9 @@ public override IObservable<OutputClockParameters> Generate()
                 });
         }
     }
+
+    /// <inheritdoc cref = "OutputClockHardwareParameters"/>v
+    [Obsolete("This operator is obsolete. Use OutputClockHardwareParameters instead. Will be removed in version 1.0.0.")]
+    public class OutputClockData : OutputClockHardwareParameters { }
+
 }