namespace ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;

/// <summary>
/// Canonical KPI scope discriminators ("KPI History &amp; Trends") — the value of
/// <see cref="ZB.MOM.WW.ScadaBridge.Commons.Entities.Kpi.KpiSample.Scope"/>. Each
/// constant's value equals its name. The companion
/// <see cref="ZB.MOM.WW.ScadaBridge.Commons.Entities.Kpi.KpiSample.ScopeKey"/> qualifies
/// the scope: <c>null</c> for <see cref="Global"/>, the site id for <see cref="Site"/>,
/// the node name for <see cref="Node"/>.
/// </summary>
public static class KpiScopes
{
    /// <summary>System-wide sample; <c>ScopeKey</c> is <c>null</c>.</summary>
    public const string Global = "Global";

    /// <summary>Per-site sample; <c>ScopeKey</c> is the site id.</summary>
    public const string Site = "Site";

    /// <summary>Per-node sample; <c>ScopeKey</c> is the node name.</summary>
    public const string Node = "Node";
}
