Address PR feedback. Fix comments. Add fields on all waveforms except spectrum.

Signed-off-by: Michael Johansen <michael.johansen@emerson.com>

Author: mjohanse-emr

ni/protobuf/types/waveform.proto

@@ -22,6 +22,8 @@ option ruby_package = "NI::Protobuf::Types";
 // A double-precision analog waveform with timing and extended properties.
 message DoubleAnalogWaveform {
   // The time of the first sample in y_data.
+  // If unset, consumers should infer the value based on timestamp and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp t0 = 1;
 
   // The time interval in seconds between data points in the waveform.
@@ -35,21 +37,27 @@ message DoubleAnalogWaveform {
 
   // A timestamp denoting some external stimulus like a trigger.
   // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp timestamp = 5;
 
-  // The offset relative to timestamp when the first sample occurs.
+  // The offset, in seconds, relative to timestamp when the first sample occurs.
   // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and timestamp,
+  // unless those values are also unset.
   double time_offset = 6;
 
   // The timestamps for each sample in y_data. The length of this field and y_data should match.
   // This is for use in cases where the waveform has irregular timing. This timestamps field
-  // is mutually exclusive with t0/timestamp/time_offset.
+  // is mutually exclusive with t0/timestamp/time_offset/dt.
   repeated PrecisionTimestamp timestamps = 7;
 }
 
 // A 16-bit integer analog waveform with timing and extended properties.
 message I16AnalogWaveform {
   // The time of the first sample in y_data.
+  // If unset, consumers should infer the value based on timestamp and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp t0 = 1;
 
   // The time interval in seconds between data points in the waveform.
@@ -66,21 +74,27 @@ message I16AnalogWaveform {
 
   // A timestamp denoting some external stimulus like a trigger.
   // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp timestamp = 6;
 
-  // The offset relative to timestamp when the first sample occurs.
+  // The offset, in seconds, relative to timestamp when the first sample occurs.
   // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and timestamp,
+  // unless those values are also unset.
   double time_offset = 7;
 
   // The timestamps for each sample in y_data. The length of this field and y_data should match.
   // This is for use in cases where the waveform has irregular timing. This timestamps field
-  // is mutually exclusive with t0/timestamp/time_offset.
+  // is mutually exclusive with t0/timestamp/time_offset/dt.
   repeated PrecisionTimestamp timestamps = 8;
 }
 
 // A double-precision complex waveform with timing and extended properties.
 message DoubleComplexWaveform {
   // The time of the first sample in y_data.
+  // If unset, consumers should infer the value based on timestamp and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp t0 = 1;
 
   // The time interval in seconds between data points in the waveform.
@@ -94,11 +108,30 @@ message DoubleComplexWaveform {
 
   // Attribute names and values. See WaveformAttributeValue for more details.
   map<string, WaveformAttributeValue> attributes = 4;
+
+  // A timestamp denoting some external stimulus like a trigger.
+  // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and time_offset,
+  // unless those values are also unset.
+  PrecisionTimestamp timestamp = 5;
+
+  // The offset, in seconds, relative to timestamp when the first sample occurs.
+  // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and timestamp,
+  // unless those values are also unset.
+  double time_offset = 6;
+
+  // The timestamps for each sample in y_data. The length of this field and y_data should match.
+  // This is for use in cases where the waveform has irregular timing. This timestamps field
+  // is mutually exclusive with t0/timestamp/time_offset/dt.
+  repeated PrecisionTimestamp timestamps = 7;
 }
 
 // A 16-bit integer complex waveform with timing and extended properties.
 message I16ComplexWaveform {
   // The time of the first sample in y_data.
+  // If unset, consumers should infer the value based on timestamp and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp t0 = 1;
 
   // The time interval in seconds between data points in the waveform.
@@ -115,6 +148,23 @@ message I16ComplexWaveform {
 
   // Optional scaling information used to convert raw data to scaled data.
   Scale scale = 5;
+
+  // A timestamp denoting some external stimulus like a trigger.
+  // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and time_offset,
+  // unless those values are also unset.
+  PrecisionTimestamp timestamp = 6;
+
+  // The offset, in seconds, relative to timestamp when the first sample occurs.
+  // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and timestamp,
+  // unless those values are also unset.
+  double time_offset = 7;
+
+  // The timestamps for each sample in y_data. The length of this field and y_data should match.
+  // This is for use in cases where the waveform has irregular timing. This timestamps field
+  // is mutually exclusive with t0/timestamp/time_offset/dt.
+  repeated PrecisionTimestamp timestamps = 8;
 }
 
 // A double-precision frequency spectrum with extended properties.
@@ -164,6 +214,8 @@ message WaveformAttributeValue {
 // A digital waveform as bytes with timing and extended properties.
 message DigitalWaveform {
   // The time of the first sample in y_data.
+  // If unset, consumers should infer the value based on timestamp and time_offset,
+  // unless those values are also unset.
   PrecisionTimestamp t0 = 1;
 
   // The time interval in seconds between data points in the waveform.
@@ -180,6 +232,23 @@ message DigitalWaveform {
 
   // Attribute names and values. See WaveformAttributeValue for more details.
   map<string, WaveformAttributeValue> attributes = 5;
+
+  // A timestamp denoting some external stimulus like a trigger.
+  // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and time_offset,
+  // unless those values are also unset.
+  PrecisionTimestamp timestamp = 6;
+
+  // The offset, in seconds, relative to timestamp when the first sample occurs.
+  // Should be specified such that t0 = timestamp + time_offset.
+  // If unset, consumers should infer the value based on t0 and timestamp,
+  // unless those values are also unset.
+  double time_offset = 7;
+
+  // The timestamps for each sample in y_data. The length of this field and y_data should match.
+  // This is for use in cases where the waveform has irregular timing. This timestamps field
+  // is mutually exclusive with t0/timestamp/time_offset/dt.
+  repeated PrecisionTimestamp timestamps = 8;
 }
 
 // Scaling information for converting unscaled waveform data to scaled data.