Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/guorg/gu.units

Units of measure for C#
https://github.com/guorg/gu.units
Last synced: about 4 hours ago
JSON representation
Units of measure for C#
Host: GitHub
URL: https://github.com/guorg/gu.units
Owner: GuOrg
License: mit
Created: 2014-10-09T18:55:28.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2024-03-04T05:40:06.000Z (9 months ago)
Last Synced: 2024-11-09T18:22:16.683Z (11 days ago)
Language: C#
Homepage:
Size: 5.88 MB
Stars: 26
Watchers: 6
Forks: 12
Open Issues: 18
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project

README

        # Gu.Units.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JohanLarsson/Gu.Units?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![NuGet](https://img.shields.io/nuget/v/Gu.Units.svg)](https://www.nuget.org/packages/Gu.Units/)

[![Build status](https://ci.appveyor.com/api/projects/status/oa2o8euq95v12qi7/branch/master?svg=true)](https://ci.appveyor.com/project/JohanLarsson/gu-units/branch/master)

[![Build Status](https://dev.azure.com/guorg/Gu.Units/_apis/build/status/GuOrg.Gu.Units?branchName=master)](https://dev.azure.com/guorg/Gu.Units/_build/latest?definitionId=1&branchName=master)

# Contents.

- [1. Quantity types.](#1-quantity-types)

- [2. Features](#2-features)

  - [2.1. Arithmetic.](#21-arithmetic)

  - [2.2. Conversion.](#22-conversion)

  - [2.3. Formatting.](#23-formatting)

  - [2.4. Parsing.](#24-parsing)

- [3. Gu.Units.WPF.](#3-guunitswpf)

  - [3.1. Simple sample.](#31-simple-sample)

  - [3.2. ValueFormat.](#32-valueformat)

  - [3.3. SymbolFormat.](#33-symbolformat)

  - [3.4. UnitInput](#34-unitinput)

- [4. Gu.Units.Json.](#4-guunitsjson)

- [5. Code generation when adding new quantities.](#5-code-generation-when-adding-new-quantities)

# 1. Quantity types.

 - Acceleration

 - AmountOfSubstance

 - Angle

 - AnglePerUnitless

 - AngularAcceleration

 - AngularJerk

 - AngularSpeed

 - Area

 - AreaDensity

 - Capacitance

 - CatalyticActivity

 - Current

 - Data

 - Density

 - ElectricalConductance

 - ElectricCharge

 - Energy

 - Flexibility

 - Force

 - ForcePerUnitless

 - Frequency

 - Illuminance

 - Inductance

 - Jerk

 - KinematicViscosity

 - Length

 - LengthPerUnitless

 - LuminousFlux

 - LuminousIntensity

 - MagneticFieldStrength

 - MagneticFlux

 - Mass

 - MassFlow

 - Momentum

 - Power

 - Pressure

 - Resistance

 - SolidAngle

 - SpecificEnergy

 - SpecificVolume

 - Speed

 - Stiffness

 - Temperature

 - Time

 - Torque

 - Unitless

 - Voltage

 - Volume

 - VolumetricFlow

 - Wavenumber

# 2. Features

## 2.1. Arithmetic.

```c#

private static LengthUnit m = LengthUnit.m;

private static TimeUnit s = TimeUnit.s;

[Test]

public void ArithmeticSample()

{

    Length length = 1*m;

    Time time = 2*s;

    Speed speed = length/time;

    Assert.AreEqual(0.5, speed.MetresPerSecond);

}

```

## 2.2. Conversion.

```c#

[Test]

public void Sample()

{

    var l = Length.FromCentimetres(1.2);

    Assert.AreEqual(0.012, l.Metres);

}

```

## 2.3. Formatting.

A large number of overloads for `ToString()`

```c#

[Test]

public void FormatSpeed()

{

    var speed = Speed.FromMetresPerSecond(1.2);

    using (Thread.CurrentThread.UsingTempCulture(CultureInfo.InvariantCulture))

    {

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString());

        Assert.AreEqual("1.20 m/s", speed.ToString("F2 m/s"));

        Assert.AreEqual(UnknownFormat, 1.2.ToString(UnknownFormat)); // for comparison

        Assert.AreEqual(UnknownFormat, speed.ToString(UnknownFormat));

        Assert.AreEqual("F1\u00A0{unit: invalid}", speed.ToString("F1 invalid"));

        Assert.AreEqual("1.20 m⋅s⁻¹", speed.ToString("F2 m⋅s⁻¹"));

        Assert.AreEqual("1.2\u00A0m⋅s⁻¹", speed.ToString("f1", "m⋅s⁻¹"));

        Assert.AreEqual("1.2 m⋅s⁻¹", speed.ToString("f1 ", "m⋅s⁻¹"));

        Assert.AreEqual("1.2 m⋅s⁻¹", speed.ToString("f1", " m⋅s⁻¹"));

        Assert.AreEqual("1.2  m⋅s⁻¹", speed.ToString("f1 ", " m⋅s⁻¹"));

        Assert.AreEqual("{value: null} mm⋅s⁻¹", speed.ToString("mm⋅s⁻¹"));

        Assert.AreEqual("1200\u00A0s⁻¹⋅mm", speed.ToString("F0", "s⁻¹⋅mm"));

        Assert.AreEqual("1200\u00A0s⁻¹⋅mm¹", speed.ToString("F0", "s⁻¹⋅mm¹"));

        Assert.AreEqual("1.2\u00A0m*s^-1", speed.ToString("F1", "m*s^-1"));

        Assert.AreEqual("1.2\u00A0s^-1*m", speed.ToString("F1", "s^-1*m"));

        Assert.AreEqual("1.2\u00A0s^-1*m^1", speed.ToString("F1", "s^-1*m^1"));

        Assert.AreEqual("4.32\u00A0km/h", speed.ToString(SpeedUnit.KilometresPerHour));

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.Default));

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.FractionHatPowers));

        Assert.AreEqual("1.2\u00A0m*s^-1", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.SignedHatPowers));

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.FractionSuperScript));

        Assert.AreEqual("1.2\u00A0m⋅s⁻¹", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.SignedSuperScript));

        Assert.AreEqual("4.3\u00A0km/h", speed.ToString("F1", SpeedUnit.KilometresPerHour));

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.Default));

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.FractionHatPowers));

        Assert.AreEqual("1.2\u00A0m*s^-1", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.SignedHatPowers));

        Assert.AreEqual("1.2\u00A0m/s", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.FractionSuperScript));

        Assert.AreEqual("1.2\u00A0m⋅s⁻¹", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.SignedSuperScript));

        Assert.AreEqual("1,200.00 mm⋅s⁻¹", speed.ToString("N mm⋅s⁻¹"));

    }

    var sv = CultureInfo.GetCultureInfo("sv-SE");

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString(sv));

    Assert.AreEqual("1,20 m/s", speed.ToString("F2 m/s", sv));

    Assert.AreEqual(UnknownFormat, 1.2.ToString(UnknownFormat, sv)); // for comparison

    Assert.AreEqual(UnknownFormat, speed.ToString(UnknownFormat, sv));

    Assert.AreEqual("F1\u00A0{unit: invalid}", speed.ToString("F1 invalid", sv));

    Assert.AreEqual("1,20 m⋅s⁻¹", speed.ToString("F2 m⋅s⁻¹", sv));

    Assert.AreEqual("1,2\u00A0m⋅s⁻¹", speed.ToString("f1", "m⋅s⁻¹", sv));

    Assert.AreEqual("1,2 m⋅s⁻¹", speed.ToString("f1 ", "m⋅s⁻¹", sv));

    Assert.AreEqual("1,2 m⋅s⁻¹", speed.ToString("f1", " m⋅s⁻¹", sv));

    Assert.AreEqual("1,2  m⋅s⁻¹", speed.ToString("f1 ", " m⋅s⁻¹", sv));

    Assert.AreEqual("{value: null} mm⋅s⁻¹", speed.ToString("mm⋅s⁻¹", sv));

    Assert.AreEqual("1200\u00A0s⁻¹⋅mm", speed.ToString("F0", "s⁻¹⋅mm", sv));

    Assert.AreEqual("1200\u00A0s⁻¹⋅mm¹", speed.ToString("F0", "s⁻¹⋅mm¹", sv));

    Assert.AreEqual("1,2\u00A0m*s^-1", speed.ToString("F1", "m*s^-1", sv));

    Assert.AreEqual("1,2\u00A0s^-1*m", speed.ToString("F1", "s^-1*m", sv));

    Assert.AreEqual("1,2\u00A0s^-1*m^1", speed.ToString("F1", "s^-1*m^1", sv));

    Assert.AreEqual("4,32\u00A0km/h", speed.ToString(SpeedUnit.KilometresPerHour, sv));

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.Default, sv));

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.FractionHatPowers, sv));

    Assert.AreEqual("1,2\u00A0m*s^-1", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.SignedHatPowers, sv));

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.FractionSuperScript, sv));

    Assert.AreEqual("1,2\u00A0m⋅s⁻¹", speed.ToString(SpeedUnit.MetresPerSecond, SymbolFormat.SignedSuperScript, sv));

    Assert.AreEqual("4,3\u00A0km/h", speed.ToString("F1", SpeedUnit.KilometresPerHour, sv));

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.Default, sv));

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.FractionHatPowers, sv));

    Assert.AreEqual("1,2\u00A0m*s^-1", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.SignedHatPowers, sv));

    Assert.AreEqual("1,2\u00A0m/s", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.FractionSuperScript, sv));

    Assert.AreEqual("1,2\u00A0m⋅s⁻¹", speed.ToString("F1", SpeedUnit.MetresPerSecond, SymbolFormat.SignedSuperScript, sv));

    Assert.AreEqual("1\u00A0200,00 mm⋅s⁻¹", speed.ToString("N mm⋅s⁻¹", sv));

}

```

## 2.4. Parsing.

```c#

[TestCase("1.2m/s")]

[TestCase("1.2m^1/s^1")]

[TestCase("1.2m^1*s^-1")]

[TestCase("1.2m^1*s^-1")]

[TestCase("1.2m⋅s⁻¹")]

[TestCase("1.2m¹/s¹")]

[TestCase("1.2m^1/s¹")]

public void ParsingSample(string text)

{

    var speed = Speed.Parse(text, CultureInfo.InvariantCulture);

    Assert.AreEqual(Speed.FromMetresPerSecond(1.2), Speed.Parse(text));

    Assert.IsTrue(Speed.TryParse(text, CultureInfo.InvariantCulture, out speed));

    Assert.AreEqual(Speed.FromMetresPerSecond(1.2), Speed.Parse(text));

}

```

# 3. Gu.Units.WPF.

[![NuGet](https://img.shields.io/nuget/v/Gu.Units.Wpf.svg)](https://www.nuget.org/packages/Gu.Units.Wpf/)

Valueconverters for binding to quantity types.

## 3.1. Simple sample.

```xaml

```

Where the viewmodel has this property.

```c#

public Length Length

{

    get { return this.length; }

    set

    {

        if (value.Equals(this.length))

        {

            return;

        }

        this.length = value;

        this.OnPropertyChanged();

    }

}

```

## 3.2. ValueFormat.

Specifies how the scalar part is formatted, formats valid for `double` are valid.

```xaml

```

## 3.3. SymbolFormat.

Specifies how the symbol is formatted.

```xaml

Text="{Binding Speed,

               Converter={units:SpeedConverter mm/s, SymbolFormat=SignedSuperScript}}" />

```

## 3.4. UnitInput

Specifies how the symbol is formatted. The default value is `ScalarOnly`.

```xaml

Text="{Binding Length,

               Converter={units:LengthConverter m, UnitInput=SymbolRequired}}" />

```

# 4. Gu.Units.Json.

[![NuGet](https://img.shields.io/nuget/v/Gu.Units.Json.svg)](https://www.nuget.org/packages/Gu.Units.Json/)

Jsonconverters for serializtion using [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/).

# 5. Code generation when adding new quantities.

For adding new units and quantities read [this](https://github.com/JohanLarsson/Gu.Units/blob/master/Gu.Units.Generator/Templates/Readme.md)