mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-29 15:11:53 +08:00
Marc Schier
889572472f
Convert `DataValue` from a mutable reference type (`class`) to a `readonly struct` to eliminate per-allocation GC pressure on every attribute read, subscription publish, and history sample. ### Key API changes (user-visible) | Before | After | Pattern | |---|---|---| | `class DataValue` | `readonly struct DataValue : INullable` | Foundation | | `Equals(DataValue?)` / `operator ==(DataValue?, DataValue?)` | `Equals(DataValue)` / `operator ==(DataValue, DataValue)` | Value semantics | | `IEncoder.WriteDataValue(string?, DataValue?)` | `IEncoder.WriteDataValue(string?, DataValue)` | Non-nullable wire API | | `IDecoder.ReadDataValue(...) -> DataValue?` | `IDecoder.ReadDataValue(...) -> DataValue` | Same | | `IDataChangeMonitoredItemQueue.PeekLast/Oldest()` | `TryPeekLastValue/Oldest(out DataValue)` | TryGet pattern | | `IAggregateCalculator.GetProcessedValue(bool)` | `TryGetProcessedValue(bool, out DataValue)` | Same | | `IUaPubSubDataStore.ReadPublishedDataItem(...)` | `TryReadPublishedDataItem(NodeId, uint, out DataValue)` | Same | | `Dictionary<uint, DataValue?>` (NodeCacheContext) | `Dictionary<uint, DataValue>` | Default + IsNull | | `IHistoryDataSource.FirstRaw/NextRaw` | `TryFirstRaw/TryNextRaw(out DataValue)` | TryGet pattern | | `NodeState.ReadAttribute(... DataValue)` | `NodeState.ReadAttribute(... ref DataValue)` | Sync mutation via ref | | `NodeState.ReadAttributeAsync(... DataValue)` | `NodeState.ReadAttributeAsync(...) -> ValueTask<(ServiceResult, DataValue)>` | Async return tuple | | `obj as DataValue` (heterogeneous Dictionary<string, object>) | `obj is DataValue dv ? dv : default(DataValue)` | Safe struct cast | | `Assert.That(dv, Is.Not.Null)` (tests) | `Assert.That(dv.IsNull, Is.False)` | Struct test pattern | | `[Obsolete] Value` setter, all property setters | Removed; use ctor or `With*()` | Immutability | | `[DataContract]` + `[DataMember]` | Removed; surrogate via `SerializableDataValue` + `DataValueSurrogateProvider` | Serialization | ### Wire format Wire format is **byte-identical** to the previous class-based implementation across binary / JSON / XML encoders. Default DataValue (`.IsNull == true`) is treated as the equivalent of the old null reference (writes JSON `null`, binary `byte 0`, XML omitted element). ### Why TryGet pattern (instead of leaving `DataValue?`) For methods that previously returned `DataValue?` to signal "no value available" (queue peek, aggregate result, data store lookup, history navigation), the conversion to `bool TryGet(out DataValue)` matches BCL conventions (`Dictionary.TryGetValue`, `Queue.TryPeek`, `Int32.TryParse`) and gives the caller an explicit "may be absent" affordance without `Nullable<DataValue>` overhead. ### Breaking changes summary - `DataValue` is now a `readonly struct` - boxing/unboxing semantics change for callers using `object`-typed APIs. - `IEncoder.WriteDataValue` / `IDecoder.ReadDataValue` / `ReadDataValueArray` interface signatures lose the `Nullable` wrapper. - `IDataChangeMonitoredItemQueue.PeekLastValue` / `PeekOldestValue` -> `TryPeekLastValue` / `TryPeekOldestValue` (out parameter). - `IAggregateCalculator.GetProcessedValue` -> `TryGetProcessedValue` (out parameter). - `IUaPubSubDataStore.ReadPublishedDataItem` -> `TryReadPublishedDataItem` (out parameter). - `NodeState.ReadAttribute` takes `ref DataValue`; `ReadAttributeAsync` returns `ValueTask<(ServiceResult, DataValue)>`. - `DataValue` property setters removed (use constructor + `With*` mutators).
365 lines
15 KiB
C#
365 lines
15 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
using System.Collections.Generic;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Server.Tests
|
|
{
|
|
[TestFixture]
|
|
[Category("AverageAggregateCalculator")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
[Parallelizable]
|
|
public class AverageAggregateCalculatorTests
|
|
{
|
|
private ITelemetryContext m_telemetry;
|
|
private AggregateConfiguration m_configuration;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
m_telemetry = NUnitTelemetryContext.Create();
|
|
m_configuration = new AggregateConfiguration
|
|
{
|
|
TreatUncertainAsBad = false,
|
|
PercentDataBad = 100,
|
|
PercentDataGood = 100,
|
|
UseSlopedExtrapolation = false
|
|
};
|
|
}
|
|
|
|
private static List<DataValue> CreateDataValues(
|
|
DateTimeUtc startTime, double[] values, double intervalMs = 1000)
|
|
{
|
|
var dataValues = new List<DataValue>();
|
|
for (int i = 0; i < values.Length; i++)
|
|
{
|
|
dataValues.Add(new DataValue(
|
|
new Variant(values[i]),
|
|
StatusCodes.Good,
|
|
startTime.AddMilliseconds(i * intervalMs),
|
|
startTime.AddMilliseconds(i * intervalMs)));
|
|
}
|
|
return dataValues;
|
|
}
|
|
|
|
private DataValue ComputeAggregate(
|
|
NodeId aggregateId,
|
|
List<DataValue> values,
|
|
DateTimeUtc startTime,
|
|
DateTimeUtc endTime,
|
|
double processingInterval)
|
|
{
|
|
IAggregateCalculator calculator = Aggregators.CreateStandardCalculator(
|
|
aggregateId, startTime, endTime, processingInterval, false, m_configuration, m_telemetry);
|
|
|
|
foreach (DataValue value in values)
|
|
{
|
|
calculator.QueueRawValue(value);
|
|
}
|
|
|
|
var results = new List<DataValue>();
|
|
bool hasData = true;
|
|
while (hasData)
|
|
{
|
|
bool _hasresult = calculator.TryGetProcessedValue(true, out DataValue result);
|
|
if (_hasresult)
|
|
{
|
|
results.Add(result);
|
|
}
|
|
else
|
|
{
|
|
hasData = false;
|
|
}
|
|
}
|
|
|
|
return results.Count > 0 ? results[0] : default;
|
|
}
|
|
|
|
[Test]
|
|
public void AverageReturnsCorrectMean()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 40, 50, 50];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Average,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double avg = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(avg, Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void AverageIdenticalValuesReturnsThatValue()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [25, 25, 25, 25, 25, 25];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Average,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double avg = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(avg, Is.EqualTo(25.0).Within(0.0001));
|
|
}
|
|
|
|
[Test]
|
|
public void AverageNegativeValues()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [-10, -20, -30, -40, -50, -50];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Average,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double avg = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(avg, Is.LessThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void AverageSingleValueReturnsThatValue()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [42.5, 42.5];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(4000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Average,
|
|
dataValues, startTime, endTime, 4000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void AverageResultHasCalculatedAggregateBits()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 30];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(8000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Average,
|
|
dataValues, startTime, endTime, 8000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.StatusCode.AggregateBits.HasFlag(AggregateBits.Calculated), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void TimeAverageReturnsResult()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 40, 50, 50];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_TimeAverage,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double timeAvg = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(timeAvg, Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void TimeAverage2ReturnsResult()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 40, 50, 50];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_TimeAverage2,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double timeAvg2 = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(timeAvg2, Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void TotalReturnsResult()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 40, 50, 50];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Total,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double total = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(total, Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void Total2ReturnsResult()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 40, 50, 50];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Total2,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double total2 = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(total2, Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void TimeAverageWithConstantValueReturnsConstant()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [42, 42, 42, 42, 42, 42];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_TimeAverage,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double timeAvg = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(timeAvg, Is.EqualTo(42.0).Within(0.5));
|
|
}
|
|
|
|
[Test]
|
|
public void TotalResultHasCalculatedAggregateBits()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 30];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(8000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Total,
|
|
dataValues, startTime, endTime, 8000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.StatusCode.AggregateBits.HasFlag(AggregateBits.Calculated), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void AverageOfSymmetricValuesReturnsMiddle()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 20, 10, 10];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_Average,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
double avg = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(avg, Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public void TimeAverage2WithConstantValueReturnsConstant()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [100, 100, 100, 100, 100, 100];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(12000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_TimeAverage2,
|
|
dataValues, startTime, endTime, 12000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.WrappedValue.IsNull, Is.False);
|
|
double timeAvg2 = (double)result.WrappedValue.ConvertToDouble();
|
|
Assert.That(timeAvg2, Is.EqualTo(100.0).Within(0.5));
|
|
}
|
|
|
|
[Test]
|
|
public void TimeAverageResultHasCalculatedAggregateBits()
|
|
{
|
|
var startTime = new DateTimeUtc(2024, 1, 1, 0, 0, 0);
|
|
DateTimeUtc firstValueTime = startTime.AddMilliseconds(500);
|
|
double[] values = [10, 20, 30, 30];
|
|
List<DataValue> dataValues = CreateDataValues(firstValueTime, values, 2000);
|
|
DateTimeUtc endTime = startTime.AddMilliseconds(8000);
|
|
|
|
DataValue result = ComputeAggregate(
|
|
ObjectIds.AggregateFunction_TimeAverage,
|
|
dataValues, startTime, endTime, 8000);
|
|
|
|
Assert.That(result.IsNull, Is.False);
|
|
Assert.That(result.StatusCode.AggregateBits.HasFlag(AggregateBits.Calculated), Is.True);
|
|
}
|
|
}
|
|
}
|