feat(historian): support Total aggregate (client-side Average x interval-seconds)
This commit is contained in:
+47
-4
@@ -92,6 +92,13 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
|
||||
}
|
||||
|
||||
/// <summary>Asynchronously reads processed historical data with aggregation for a tag within a time range.</summary>
|
||||
/// <remarks>
|
||||
/// <see cref="HistoryAggregateType.Total"/> is derived client-side as the time-weighted
|
||||
/// Average × interval-seconds; Wonderware AnalogSummary exposes no Total column. The wire
|
||||
/// request is issued with the Average column and each returned bucket value is scaled by
|
||||
/// <c>interval.TotalSeconds</c>, preserving the bucket's status code and timestamp. All
|
||||
/// other aggregates pass through unchanged.
|
||||
/// </remarks>
|
||||
/// <param name="fullReference">The full reference path of the tag to read.</param>
|
||||
/// <param name="startUtc">The start time in UTC for the read range.</param>
|
||||
/// <param name="endUtc">The end time in UTC for the read range.</param>
|
||||
@@ -103,19 +110,52 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
|
||||
string fullReference, DateTime startUtc, DateTime endUtc, TimeSpan interval,
|
||||
HistoryAggregateType aggregate, CancellationToken cancellationToken)
|
||||
{
|
||||
// Total has no AnalogSummary column — request the time-weighted Average and scale
|
||||
// client-side below (Total = Average × interval-seconds).
|
||||
var isDerivedTotal = aggregate == HistoryAggregateType.Total;
|
||||
var wireAggregate = isDerivedTotal ? HistoryAggregateType.Average : aggregate;
|
||||
|
||||
var req = new ReadProcessedRequest
|
||||
{
|
||||
TagName = fullReference,
|
||||
StartUtcTicks = startUtc.Ticks,
|
||||
EndUtcTicks = endUtc.Ticks,
|
||||
IntervalMs = interval.TotalMilliseconds,
|
||||
AggregateColumn = MapAggregate(aggregate),
|
||||
AggregateColumn = MapAggregate(wireAggregate),
|
||||
CorrelationId = Guid.NewGuid().ToString("N"),
|
||||
};
|
||||
var reply = await InvokeAndClassifyAsync<ReadProcessedRequest, ReadProcessedReply>(
|
||||
MessageKind.ReadProcessedRequest, MessageKind.ReadProcessedReply, req,
|
||||
r => (r.Success, r.Error), "ReadProcessed", cancellationToken).ConfigureAwait(false);
|
||||
return new HistoryReadResult(ToAggregateSnapshots(reply.Buckets), ContinuationPoint: null);
|
||||
|
||||
var buckets = isDerivedTotal
|
||||
? ScaleAverageToTotal(reply.Buckets, interval.TotalSeconds)
|
||||
: reply.Buckets;
|
||||
return new HistoryReadResult(ToAggregateSnapshots(buckets), ContinuationPoint: null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Derives <see cref="HistoryAggregateType.Total"/> buckets from time-weighted Average
|
||||
/// buckets using the time-integral identity Total = Average × interval-seconds. Null
|
||||
/// (unavailable) buckets are carried through unscaled so the downstream null→BadNoData
|
||||
/// mapping still fires; non-null values are multiplied by <paramref name="intervalSeconds"/>.
|
||||
/// </summary>
|
||||
private static HistorianAggregateSampleDto[] ScaleAverageToTotal(
|
||||
HistorianAggregateSampleDto[] averages, double intervalSeconds)
|
||||
{
|
||||
if (averages.Length == 0) return averages;
|
||||
var totals = new HistorianAggregateSampleDto[averages.Length];
|
||||
for (var i = 0; i < averages.Length; i++)
|
||||
{
|
||||
var avg = averages[i];
|
||||
totals[i] = new HistorianAggregateSampleDto
|
||||
{
|
||||
// Null (unavailable) average → null total (→ BadNoData downstream).
|
||||
Value = avg.Value is { } v ? v * intervalSeconds : null,
|
||||
TimestampUtcTicks = avg.TimestampUtcTicks,
|
||||
};
|
||||
}
|
||||
return totals;
|
||||
}
|
||||
|
||||
/// <summary>Asynchronously reads historical data at specific timestamps for a tag.</summary>
|
||||
@@ -510,14 +550,17 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
|
||||
_ => 500,
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// Maps an OPC UA aggregate to its Wonderware AnalogSummary column name. There is no
|
||||
/// Total column — <see cref="HistoryAggregateType.Total"/> is derived client-side in
|
||||
/// <see cref="ReadProcessedAsync"/> by requesting Average, so it is never passed here.
|
||||
/// </summary>
|
||||
private static string MapAggregate(HistoryAggregateType aggregate) => aggregate switch
|
||||
{
|
||||
HistoryAggregateType.Average => "Average",
|
||||
HistoryAggregateType.Minimum => "Minimum",
|
||||
HistoryAggregateType.Maximum => "Maximum",
|
||||
HistoryAggregateType.Count => "ValueCount",
|
||||
HistoryAggregateType.Total => throw new NotSupportedException(
|
||||
"HistoryAggregateType.Total is not supported by the Wonderware AnalogSummary query — use Average/Minimum/Maximum/Count."),
|
||||
_ => throw new NotSupportedException($"Unknown HistoryAggregateType {aggregate}"),
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user