Class UnitFactory

Namespace: Codebelt.Unitify

Assembly: Codebelt.Unitify.dll

Provides a set of static methods for generating different types of unit of measure and the option to define your own with CreateUnit(string, string, string, double, IPrefix, Action<UnitFormatOptions>).

Examples

Create SI units with predefined base values using factory methods. This example demonstrates factory methods for different unit types (meter, watt, byte, and second), each creating a fully-configured unit instance with a base value so you can immediately start formatting and working with the result:

using System;
using Codebelt.Unitify;

namespace Unitify.Samples;

public class UnitFactoryExample
{
    public static void Main()
    {
        // Create a meter unit
        var meter = UnitFactory.CreateMeter(100);
        Console.WriteLine($"Distance: {meter}");
        
        // Create a watt unit
        var watt = UnitFactory.CreateWatt(1500);
        Console.WriteLine($"Power: {watt}");
        
        // Create a byte unit for data storage
        var byte_unit = UnitFactory.CreateByte(1024);
        Console.WriteLine($"Data: {byte_unit}");
        
        // Create a second unit for time
        var second = UnitFactory.CreateSecond(3600);
        Console.WriteLine($"Time: {second}");
    }
}

public static class UnitFactory

Inheritance: object

UnitFactory

Methods

CreateAmpere(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Electric Current in amperes.

public static IPrefixUnit CreateAmpere(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Electric Current in amperes.

See Also: Ampere

CreateBecquerel(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Radioactivity in becquerels.

public static IPrefixUnit CreateBecquerel(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Radioactivity in becquerels.

See Also: Becquerel

CreateBit(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Data Quantity in bits.

public static IPrefixUnit CreateBit(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The optional prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Data Quantity in bits.

See Also: Bit

CreateBitPerSecond(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Transmission Rate in bits per second.

public static IPrefixUnit CreateBitPerSecond(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Transmission Rate in bits per second.

See Also: BitPerSecond

CreateByte(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Data Quantity in bytes.

public static IPrefixUnit CreateByte(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The optional prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Data Quantity in bytes.

See Also: Byte

CreateCandela(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Luminous Intensity in candelas.

public static IPrefixUnit CreateCandela(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Luminous Intensity in candelas.

See Also: Candela

CreateCelsius(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Temperature in degrees Celsius.

public static IPrefixUnit CreateCelsius(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Temperature in degrees Celsius.

See Also: Celsius

CreateCoulomb(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Electric Charge in coulombs.

public static IPrefixUnit CreateCoulomb(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Electric Charge in coulombs.

See Also: Coulomb

CreateFarad(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Electric Capacitance in farads.

public static IPrefixUnit CreateFarad(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Electric Capacitance in farads.

See Also: Farad

CreateGram(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Mass in grams.

public static IPrefixUnit CreateGram(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Mass in grams.

See Also: Gram

CreateGray(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Absorbed Dose in grays.

public static IPrefixUnit CreateGray(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Absorbed Dose in grays.

See Also: Gray

CreateHenry(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Inductance in henries.

public static IPrefixUnit CreateHenry(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Inductance in henries.

See Also: Henry

CreateHertz(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Frequency in hertz.

public static IPrefixUnit CreateHertz(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Frequency in hertz.

See Also: Hertz

CreateJoule(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Energy in joules.

public static IPrefixUnit CreateJoule(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Energy in joules.

See Also: Joule

CreateKatal(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Catalytic Activity in katals.

public static IPrefixUnit CreateKatal(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Catalytic Activity in katals.

See Also: Katal

CreateKelvin(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Temperature in kelvin.

public static IPrefixUnit CreateKelvin(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Temperature in kelvin.

See Also: Kelvin

CreateKilogram(double, Action<UnitFormatOptions>)

Creates a unit of measure for Mass in kilograms.

public static IPrefixUnit CreateKilogram(double value, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Mass in kilograms.

See Also: Gram

CreateGram(double, IPrefix, Action<UnitFormatOptions>)

CreateLumen(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Luminous Flux in lumens.

public static IPrefixUnit CreateLumen(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Luminous Flux in lumens.

See Also: Lumen

CreateLux(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Illuminance in lux.

public static IPrefixUnit CreateLux(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Illuminance in lux.

See Also: Lux

CreateMeter(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Length in meters.

public static IPrefixUnit CreateMeter(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Length in meters.

See Also: Meter

CreateMole(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Amount of Substance in moles.

public static IPrefixUnit CreateMole(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Amount of Substance in moles.

See Also: Mole

CreateNewton(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Force in newtons.

public static IPrefixUnit CreateNewton(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Force in newtons.

See Also: Newton

CreateOhm(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Electric Resistance in ohms.

public static IPrefixUnit CreateOhm(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Electric Resistance in ohms.

See Also: Ohm

CreatePascal(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Pressure in pascals.

public static IPrefixUnit CreatePascal(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Pressure in pascals.

See Also: Pascal

CreateRadian(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Plane Angle in radians.

public static IPrefixUnit CreateRadian(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Plane Angle in radians.

See Also: Radian

CreateSecond(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Time in seconds.

public static IPrefixUnit CreateSecond(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Time in seconds.

See Also: Second

CreateSiemens(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Electric Conductance in siemens.

public static IPrefixUnit CreateSiemens(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Electric Conductance in siemens.

See Also: Siemens

CreateSievert(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Equivalent Dose in sieverts.

public static IPrefixUnit CreateSievert(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Equivalent Dose in sieverts.

See Also: Sievert

CreateSteradian(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Solid Angle in steradians.

public static IPrefixUnit CreateSteradian(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Solid Angle in steradians.

See Also: Steradian

CreateTesla(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Magnetic Flux Density in teslas.

public static IPrefixUnit CreateTesla(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Magnetic Flux Density in teslas.

See Also: Tesla

CreateUnit(string, string, string, double, IPrefix, Action<UnitFormatOptions>)

Creates a custom unit of measure.

public static IPrefixUnit CreateUnit(string category, string name, string symbol, double value, IPrefix prefix, Action<UnitFormatOptions> setup = null)

Parameters

category string: The category of the unit.
name string: The name of the unit.
symbol string: The symbol of the unit.
value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A custom unit of measure.

CreateVolt(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Electric Potential in volts.

public static IPrefixUnit CreateVolt(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Electric Potential in volts.

See Also: Volt

CreateWatt(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Power in watts.

public static IPrefixUnit CreateWatt(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Power in watts.

See Also: Watt

CreateWeber(double, IPrefix, Action<UnitFormatOptions>)

Creates a unit of measure for Magnetic Flux in webers.

public static IPrefixUnit CreateWeber(double value, IPrefix prefix = null, Action<UnitFormatOptions> setup = null)

Parameters

value double: The value of the unit.
prefix IPrefix: The prefix of the unit.
setup Action<UnitFormatOptions>: The UnitFormatOptions which may be configured.

Returns

IPrefixUnit: A unit of measure for Magnetic Flux in webers.

See Also: Weber

Table of Contents

Class UnitFactory

Examples

Methods

CreateAmpere(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateBecquerel(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateBit(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateBitPerSecond(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateByte(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateCandela(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateCelsius(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateCoulomb(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateFarad(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateGram(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateGray(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateHenry(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateHertz(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateJoule(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateKatal(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateKelvin(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateKilogram(double, Action<UnitFormatOptions>)

Parameters

Returns

CreateLumen(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateLux(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateMeter(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateMole(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateNewton(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateOhm(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreatePascal(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateRadian(double, IPrefix, Action<UnitFormatOptions>)

Parameters

Returns

CreateSecond(double, IPrefix, Action<UnitFormatOptions>)