DP.UnitAdapter 1.0.0

UnitAdapter

https://www.nuget.org/packages/UnitAdapter

Помогает выводить в UI или в отчетах значения физических величин в нужных единицах измерения. Например, когда приложение под капотом хранит массу в граммах, а пользователю необходимо ее показывать в различных единицах (килограммы, тонны).

Библиотека работает в связке с UnitConverter (https://www.nuget.org/packages/DP.UnitConverter/)

Позволяет для каждой физической величины, определенной в UnitConverter хранить и настраивать ряд параметров:

• базовые единицы измерения
• отображаемые единицы измерения
• отображаемое кол-во знаков после запятой (общее и по каждой физ.величине)

Согласно этим настройкам форматирует числа в строковые представления с указанием единиц измерения, а также осуществляет обратное преобразование из строки, содержащей значение и единицы, в число, приведенное к базовым единицам измерения.

Пример использования

В своем приложении рекомендуется создать класс обертку для UnitAdapter, который будет производить инициализацию (определение базовых единиц и загрузка настроек пользователя).

internal static class AppUnitsProxy
{
    internal static void Initialize()
    {
        // TODO Актуализация базовых единиц
        // TODO Загрузка и установка пользовательских настроек
    }
}

Так же в этом же классе можно разместить обертки для функций UnitAdapter с учетом специфики приложения.

Например, ваше приложение использует в качестве идентификатора физической величины enum Quantity(Weight, Volume,...) (а в UnitAdapter идентификатор физ.величины - строковое имя на английском языке). Тогда обертка одного из методов UnitAdapter может выглядеть так:

internal static class AppUnitsProxy
{
    ...

    internal static double ConvertBaseToDisplay(long value, Quantity quantity)
    {
        // где ToCategoryName() - расширение, преобразующее enum в строковое имя физической величины
        return UnitAdapter.ConvertBaseToDisplay(value, quantity.ToCategoryName());
    }

    ...

}

Так же, для удобства можно создать расширения для функций UnitAdapter. Это позволит обращаться к ним следущим образом:

// преобразовать 42 из базовых единиц объема к отображаемым и отформатировать:
// - округлить до нужного знака (из настроек)
// - добавить единицы измерения (из настроек)

42.ToDisplayUnit(Quantity.Volume);

Для использования в XAML можно создать конвертеры. Ниже приводится конвертер только для массы, но можно создать и универсальный для любой физической величины (это потребует доставлять в конвертер данные о том, что это за физ.величина).

    public class MassValueConverter : IValueConverter
    {
        public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
        {
            if (value == null) return null;

            var cult = CultureInfo.CurrentCulture;

            var digitValue = AppUnitsProxy.LongToLong(value, cult);
            if (digitValue == null) return null;

            return AppUnitsProxy.ToDisplayUnit(
                digitValue,
                Quantity.Weight,
                new ToStringParameters
                {
                    Culture = cult,
                    SimpleZero = true,
                    AnywayPlus = parameter is string str && str == "ShowPlus"
                });
        }


        public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
        {
            var result = AppUnitsProxy.ToLong(
                value,
                CategoryInfo.Weight.BaseUnits,
                new ToNumberParameters
                {
                    Culture = CultureInfo.CurrentCulture,
                    AbsoluteValue = parameter?.ToString() != "NegativeValueAllowed"
                });

            return result.Ok ? result.Value : DependencyProperty.UnsetValue;
        }
    }