namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Sql.Common;

/// <summary>Part 4 §7.39 historian info bits OR-ed onto a status code.</summary>
public static class HistorianInfoBits
{
    /// <summary>InfoType = DataValue.</summary>
    public const uint InfoTypeDataValue = 0x00000400u;

    /// <summary>The value was produced by an aggregate calculation.</summary>
    public const uint HistorianCalculated = 0x1u;

    /// <summary>The value was interpolated.</summary>
    public const uint HistorianInterpolated = 0x2u;

    /// <summary>
    ///     Partial (Part 4 §7.39 / <c>Opc.Ua.AggregateBits.Partial</c>): the calculated value covers an interval shorter
    ///     than the processing interval (the truncated last interval of a processed read).
    /// </summary>
    public const uint HistorianPartial = 0x4u;

    /// <summary>
    ///     Marks <paramref name="status"/> as a Calculated data value. Any historian bits the status already carries
    ///     (e.g. a stored Interpolated sample) are cleared first, so the result is never both.
    /// </summary>
    /// <param name="status">Base status code.</param>
    /// <returns>Status with InfoType and Calculated bits set.</returns>
    public static uint WithCalculated(uint status) =>
        (status & ~StatusBits.HistorianBitsMask) | InfoTypeDataValue | HistorianCalculated;

    /// <summary>
    ///     Marks <paramref name="status"/> as an Interpolated data value. Any historian bits the status already
    ///     carries (e.g. a stored Calculated sample) are cleared first, so the result is never both.
    /// </summary>
    /// <param name="status">Base status code.</param>
    /// <returns>Status with InfoType and Interpolated bits set.</returns>
    public static uint WithInterpolated(uint status) =>
        (status & ~StatusBits.HistorianBitsMask) | InfoTypeDataValue | HistorianInterpolated;
}