Skip to content

Commit 6dbe5b8

Browse files
committed
Spelling and grammar fixes
1 parent f9f1133 commit 6dbe5b8

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

OpenEphys.Onix1/ConfigureLoadTester.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ public ConfigureLoadTester()
3232
public bool Enable { get; set; } = false;
3333

3434
/// <summary>
35-
/// Gets or sets the number of repetitions incrementing, unsigned 16-bit integers sent with each read frame.
35+
/// Gets or sets the number of incrementing, unsigned 16-bit integers sent with each read frame.
3636
/// </summary>
3737
/// <remarks>
38-
/// These data are produced by the controller and are used to impose a load the controller to host
38+
/// These data are produced by the controller and are used to impose a load on the controller to host
3939
/// communication. These data can be used in downstream computational operations that model the
4040
/// computational load imposed by a closed-loop algorithm.
4141
/// </remarks>
4242
[Category(ConfigurationCategory)]
43-
[Description("Number of repetitions of the 16-bit unsigned integer 42 sent with each read-frame.")]
43+
[Description("Number of incrementing, unsigned 16-bit integers sent with each read-frame.")]
4444
[Range(0, 10e6)]
4545
public uint ReceivedWords { get; set; }
4646

@@ -53,7 +53,7 @@ public ConfigureLoadTester()
5353
/// commutation. They are discarded by the controller when they are received.
5454
/// </remarks>
5555
[Category(ConfigurationCategory)]
56-
[Description("Number of repetitions of the 32-bit integer 42 sent with each write frame.")]
56+
[Description("Number of repetitions of the 32-bit integer dummy words sent with each write frame.")]
5757
[Range(0, 10e6)]
5858
public uint TransmittedWords { get; set; }
5959

OpenEphys.Onix1/LoadTesterData.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
namespace OpenEphys.Onix1
88
{
99
/// <summary>
10-
/// Produces a sequence of heartbeat data frames.
10+
/// Produces a sequence of LoadTester data frames.
1111
/// </summary>
1212
/// <remarks>
1313
/// This data IO operator must be linked to an appropriate configuration, such as a <see
14-
/// cref="ConfigureHeartbeat"/>, using a shared <c>DeviceName</c>.
14+
/// cref="ConfigureLoadTester"/>, using a shared <c>DeviceName</c>.
1515
/// </remarks>
1616
[Description("Produces a sequence of load tester data frames.")]
1717
public class LoadTesterData : Source<LoadTesterDataFrame>

OpenEphys.Onix1/LoadTesterLoopback.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,14 @@
66

77
namespace OpenEphys.Onix1
88
{
9-
109
/// <summary>
1110
/// Sends loopback data to the load testing device for closed-loop latency measurement.
1211
/// </summary>
1312
/// <remarks>
1413
/// This data IO operator must be linked to an appropriate configuration, such as a <see
1514
/// cref="ConfigureLoadTester"/>, using a shared <c>DeviceName</c>.
1615
/// </remarks>
17-
[Description("Sends analog output data to an ONIX breakout board.")]
16+
[Description("Sends loopback data to an ONIX breakout board.")]
1817
public class LoadTesterLoopback : Sink<ulong>
1918
{
2019
/// <inheritdoc cref = "SingleDeviceFactory.DeviceName"/>
@@ -24,16 +23,16 @@ public class LoadTesterLoopback : Sink<ulong>
2423
public string DeviceName { get; set; }
2524

2625
/// <summary>
27-
/// Creates and sends an loopback frame to the load testing device.
26+
/// Creates and sends a loopback frame to the load testing device.
2827
/// </summary>
2928
/// <remarks>
30-
/// A loopback frame consists the <c>ulong</c> loopback value provided by <paramref name="source"/>
29+
/// A loopback frame consists of the <c>ulong</c> loopback value provided by <paramref name="source"/>
3130
/// that is prepended to a <see cref="ConfigureLoadTester.TransmittedWords"/>-element <c>ushort</c>
3231
/// array of dummy data. When the frame is received by hardware, the loopback value is subtracted from
3332
/// the current hub clock count on the load testing device and stored. Therefore, if the loopback
34-
/// value is is that of a previous <see cref="DataFrame.HubClock"/> from the <see
33+
/// value is that of a previous <see cref="DataFrame.HubClock"/> from the <see
3534
/// cref="LoadTesterData"/> with the same <see cref="DeviceName"/> as this operator, this difference will provide a
36-
/// hardware-timed measurement of real-time latency. The the variably-sized dummy data in the loopback
35+
/// hardware-timed measurement of real-time latency. The variably-sized dummy data in the loopback
3736
/// frame is used for testing the effect of increasing the frame size, and thus the write
3837
/// communication bandwidth, on real-time latency.
3938
/// </remarks>

0 commit comments

Comments
 (0)