UA-.NETStandard/Libraries/Opc.Ua.PubSub/UaDataSetMessage.cs

/* ========================================================================
 * 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;
using Microsoft.Extensions.Logging;
using Opc.Ua.PubSub.PublishedData;

namespace Opc.Ua.PubSub
{
    /// <summary>
    /// Base class for a DataSet message implementation
    /// </summary>
    public abstract class UaDataSetMessage
    {
        // Configuration Major and Major current version (VersionTime)
        /// <summary>
        /// Default value for Configured MetaDataVersion.MajorVersion
        /// </summary>
        protected const uint kDefaultConfigMajorVersion = 0;

        /// <summary>
        /// Default value for Configured MetaDataVersion.MinorVersion
        /// </summary>
        protected const uint kDefaultConfigMinorVersion = 0;

        /// <summary>
        /// Create new instance of <see cref="UaDataSetMessage"/>
        /// </summary>
        protected UaDataSetMessage(ILogger logger)
        {
            m_logger = logger ?? Utils.Fallback.Logger;
            DecodeErrorReason = DataSetDecodeErrorReason.NoError;
            Timestamp = DateTime.UtcNow;
            MetaDataVersion = new ConfigurationVersionDataType
            {
                MajorVersion = kDefaultConfigMajorVersion,
                MinorVersion = kDefaultConfigMinorVersion
            };
        }

        /// <summary>
        /// Get DataSet
        /// </summary>
        public DataSet DataSet { get; internal set; } = null!;

        /// <summary>
        /// Get and Set corresponding DataSetWriterId
        /// </summary>
        public ushort DataSetWriterId { get; set; }

        /// <summary>
        /// Get DataSetFieldContentMask
        /// This DataType defines flags to include DataSet field related information like status and
        /// timestamp in addition to the value in the DataSetMessage.
        /// </summary>
        public DataSetFieldContentMask FieldContentMask { get; protected set; }

        /// <summary>
        /// The version of the DataSetMetaData which describes the contents of the Payload.
        /// </summary>
        public ConfigurationVersionDataType MetaDataVersion { get; set; }

        /// <summary>
        /// Get and Set SequenceNumber
        /// A strictly monotonically increasing sequence number assigned by the publisher to each DataSetMessage sent.
        /// </summary>
        public uint SequenceNumber { get; set; }

        /// <summary>
        /// Get and Set Timestamp
        /// </summary>
        public DateTimeUtc Timestamp { get; set; }

        /// <summary>
        /// Get and Set Status
        /// </summary>
        public StatusCode Status { get; set; }

        /// <summary>
        /// Get and Set the reason that an error encountered while decoding occurred
        /// </summary>
        public DataSetDecodeErrorReason DecodeErrorReason { get; set; }

        /// <summary>
        /// Checks if the MetadataMajorVersion has changed depending on the value of DataSetDecodeErrorReason
        /// </summary>
        public bool IsMetadataMajorVersionChange
            => DecodeErrorReason == DataSetDecodeErrorReason.MetadataMajorVersion;

        /// <summary>
        /// Set DataSetFieldContentMask
        /// </summary>
        /// <param name="fieldContentMask">The new <see cref="DataSetFieldContentMask"/> for this dataset</param>
        public abstract void SetFieldContentMask(DataSetFieldContentMask fieldContentMask);

        /// <summary>
        /// Validates the MetadataVersion against a given ConfigurationVersionDataType
        /// </summary>
        /// <param name="configurationVersionDataType">The value to validate MetadataVersion against</param>
        /// <returns>NoError if validation passes or the cause of the failure</returns>
        protected DataSetDecodeErrorReason ValidateMetadataVersion(
            ConfigurationVersionDataType configurationVersionDataType)
        {
            if (MetaDataVersion.MajorVersion != kDefaultConfigMajorVersion &&
                MetaDataVersion.MajorVersion != configurationVersionDataType.MajorVersion)
            {
                return DataSetDecodeErrorReason.MetadataMajorVersion;
            }

            return DataSetDecodeErrorReason.NoError;
        }

        /// <summary>
        /// A Logger to be used by this and derived classes
        /// </summary>
#pragma warning disable IDE1006 // Naming Styles
        protected ILogger m_logger { get; }
#pragma warning restore IDE1006 // Naming Styles
    }
}