DimensionRole.cs

namespace JSONstat.Models;

/// <summary>
/// The role of a dimension, as resolved by the library.
/// </summary>
/// <remarks>
/// The on-the-wire <c>role</c> object only knows <c>time</c>, <c>geo</c> and
/// <c>metric</c>. <see cref="Classification"/> is a JavaScript-Toolkit
/// convention used for dimensions the format leaves unroled; it is exposed on
/// the API surface but is never written to the wire (see
/// <c>../wiki/dimensions.md</c>).
/// </remarks>
public enum DimensionRole
{
    /// <summary>Temporal dimension (listed under <c>role.time</c>).</summary>
    Time,

    /// <summary>Geographic dimension (listed under <c>role.geo</c>).</summary>
    Geo,

    /// <summary>Metric/measure dimension (listed under <c>role.metric</c>).</summary>
    Metric,

    /// <summary>A dimension with no role assigned (Toolkit convention only).</summary>
    Classification
}