Class Unit

Namespace

Codebelt.Unitify

Assembly

Codebelt.Unitify.dll

Represents the base class from which all implementations of a unit of measure should derive.

public abstract class Unit : IUnit, IBaseUnit, IEquatable<IUnit>

Inheritance

object

Unit

Implements

IUnit

IBaseUnit

IEquatable<IUnit>

Derived

PrefixUnit

Constructors

Unit(IBaseUnit, double, Action<UnitFormatOptions>)

Initializes a new instance of the Unit class.

protected Unit(IBaseUnit baseUnit, double value, Action<UnitFormatOptions> setup = null)

Parameters

baseUnit IBaseUnit

The base unit of measure.

value double

The value of this unit expressed as bytes.

setup Action<UnitFormatOptions>

The UnitFormatOptions which may be configured.

Properties

Ampere

Gets the SI base unit for Electric Current.

public static IBaseUnit Ampere { get; }

Property Value

IBaseUnit

The SI base unit for Electric Current.

See Also

CreateAmpere(double, IPrefix, Action<UnitFormatOptions>)

Becquerel

Gets the SI unit for Radioactivity.

public static IBaseUnit Becquerel { get; }

Property Value

IBaseUnit

The SI unit for Radioactivity.

See Also

CreateBecquerel(double, IPrefix, Action<UnitFormatOptions>)

Bit

Gets the base unit for Data Quantity.

public static IBaseUnit Bit { get; }

Property Value

IBaseUnit

The base unit for Data Quantity.

See Also

CreateBit(double, IPrefix, Action<UnitFormatOptions>)

BitPerSecond

Gets the base unit for Transmission Rate.

public static IBaseUnit BitPerSecond { get; }

Property Value

IBaseUnit

The base unit for Transmission Rate.

See Also

CreateBitPerSecond(double, IPrefix, Action<UnitFormatOptions>)

Byte

Gets the unit for Data Quantity.

public static IBaseUnit Byte { get; }

Property Value

IBaseUnit

The unit for Data Quantity.

See Also

CreateByte(double, IPrefix, Action<UnitFormatOptions>)

Candela

Gets the SI base unit for Luminous Intensity.

public static IBaseUnit Candela { get; }

Property Value

IBaseUnit

The SI base unit for Luminous Intensity.

See Also

CreateCandela(double, IPrefix, Action<UnitFormatOptions>)

Category

Gets the category of unit.

public string Category { get; }

Property Value

string

The category of the unit.

Celsius

Gets the SI unit for Temperature.

public static IBaseUnit Celsius { get; }

Property Value

IBaseUnit

The SI unit for Temperature.

See Also

CreateCelsius(double, IPrefix, Action<UnitFormatOptions>)

Coulomb

Gets the SI unit for Electric Charge.

public static IBaseUnit Coulomb { get; }

Property Value

IBaseUnit

The SI unit for Electric Charge.

See Also

CreateCoulomb(double, IPrefix, Action<UnitFormatOptions>)

Farad

Gets the SI unit for Electric Capacitance.

public static IBaseUnit Farad { get; }

Property Value

IBaseUnit

The SI unit for Electric Capacitance.

See Also

CreateFarad(double, IPrefix, Action<UnitFormatOptions>)

FormatOptions

Gets the format options of the unit.

public UnitFormatOptions FormatOptions { get; protected set; }

Property Value

UnitFormatOptions

The format options of the unit.

Gram

Gets the opinionated base unit for Mass.

public static IBaseUnit Gram { get; }

Property Value

IBaseUnit

The opinionated base unit for Mass.

Remarks

For consistency with this library, Kilogram (which is the official SI base unit for Mass) has been replaced with Gram.

See Also

CreateGram(double, IPrefix, Action<UnitFormatOptions>)

CreateKilogram(double, Action<UnitFormatOptions>)

Gray

Gets the SI unit for Absorbed Dose.

public static IBaseUnit Gray { get; }

Property Value

IBaseUnit

The SI unit for Absorbed Dose.

See Also

CreateGray(double, IPrefix, Action<UnitFormatOptions>)

Henry

Gets the opinionated base unit for Inductance.

public static IBaseUnit Henry { get; }

Property Value

IBaseUnit

The opinionated base unit for Inductance.

See Also

CreateHenry(double, IPrefix, Action<UnitFormatOptions>)

Hertz

Gets the SI unit for Frequency.

public static IBaseUnit Hertz { get; }

Property Value

IBaseUnit

The SI unit for Frequency.

See Also

CreateHertz(double, IPrefix, Action<UnitFormatOptions>)

Joule

Gets the SI unit for Energy.

public static IBaseUnit Joule { get; }

Property Value

IBaseUnit

The SI unit for Energy.

See Also

CreateJoule(double, IPrefix, Action<UnitFormatOptions>)

Katal

Gets the SI unit for Catalytic Activity.

public static IBaseUnit Katal { get; }

Property Value

IBaseUnit

The SI unit for Catalytic Activity.

See Also

CreateKatal(double, IPrefix, Action<UnitFormatOptions>)

Kelvin

Gets the SI base unit for Temperature.

public static IBaseUnit Kelvin { get; }

Property Value

IBaseUnit

The SI base unit for Temperature.

See Also

CreateKelvin(double, IPrefix, Action<UnitFormatOptions>)

Lumen

Gets the SI unit for Luminous Flux.

public static IBaseUnit Lumen { get; }

Property Value

IBaseUnit

The SI unit for Luminous Flux.

See Also

CreateLumen(double, IPrefix, Action<UnitFormatOptions>)

Lux

Gets the SI unit for Illuminance.

public static IBaseUnit Lux { get; }

Property Value

IBaseUnit

The SI unit for Illuminance.

See Also

CreateLux(double, IPrefix, Action<UnitFormatOptions>)

Meter

Gets the SI base unit for Length.

public static IBaseUnit Meter { get; }

Property Value

IBaseUnit

The SI base unit for Length.

See Also

CreateMeter(double, IPrefix, Action<UnitFormatOptions>)

Mole

Gets the SI base unit for Amount of Substance.

public static IBaseUnit Mole { get; }

Property Value

IBaseUnit

The SI base unit for Amount of Substance.

See Also

CreateMole(double, IPrefix, Action<UnitFormatOptions>)

Name

Gets the name of this unit.

public string Name { get; }

Property Value

string

The name of this unit.

Newton

Gets the SI unit for Force.

public static IBaseUnit Newton { get; }

Property Value

IBaseUnit

The SI unit for Force.

See Also

CreateNewton(double, IPrefix, Action<UnitFormatOptions>)

Ohm

Gets the SI unit for Electric Resistance.

public static IBaseUnit Ohm { get; }

Property Value

IBaseUnit

The SI unit for Electric Resistance.

See Also

CreateOhm(double, IPrefix, Action<UnitFormatOptions>)

Pascal

Gets the SI unit for Pressure.

public static IBaseUnit Pascal { get; }

Property Value

IBaseUnit

The SI unit for Pressure.

See Also

CreatePascal(double, IPrefix, Action<UnitFormatOptions>)

Radian

Gets the SI unit for Plane Angle.

public static IBaseUnit Radian { get; }

Property Value

IBaseUnit

The SI unit for Plane Angle.

See Also

CreateRadian(double, IPrefix, Action<UnitFormatOptions>)

Second

Gets the SI base unit for Time.

public static IBaseUnit Second { get; }

Property Value

IBaseUnit

The SI base unit for Time.

See Also

CreateSecond(double, IPrefix, Action<UnitFormatOptions>)

Siemens

Gets the SI unit for Electric Conductance.

public static IBaseUnit Siemens { get; }

Property Value

IBaseUnit

The SI unit for Electric Conductance.

See Also

CreateSiemens(double, IPrefix, Action<UnitFormatOptions>)

Sievert

Gets the SI unit for Equivalent Dose.

public static IBaseUnit Sievert { get; }

Property Value

IBaseUnit

The SI unit for Equivalent Dose.

See Also

CreateSievert(double, IPrefix, Action<UnitFormatOptions>)

Steradian

Gets the SI unit for Solid Angle.

public static IBaseUnit Steradian { get; }

Property Value

IBaseUnit

The SI unit for Solid Angle.

See Also

CreateSteradian(double, IPrefix, Action<UnitFormatOptions>)

Symbol

Gets the symbol of this unit.

public string Symbol { get; }

Property Value

string

The symbol of this unit.

Tesla

Gets the SI unit for Magnetic Flux Density.

public static IBaseUnit Tesla { get; }

Property Value

IBaseUnit

The SI unit for Magnetic Flux Density.

See Also

CreateTesla(double, IPrefix, Action<UnitFormatOptions>)

Value

Gets the value of this unit expressed as bytes.

public double Value { get; }

Property Value

double

The value of this unit.

Volt

Gets the SI unit for Electric Potential.

public static IBaseUnit Volt { get; }

Property Value

IBaseUnit

The SI unit for Electric Potential.

See Also

CreateVolt(double, IPrefix, Action<UnitFormatOptions>)

Watt

Gets the SI unit for Power.

public static IBaseUnit Watt { get; }

Property Value

IBaseUnit

The SI unit for Power.

See Also

CreateWatt(double, IPrefix, Action<UnitFormatOptions>)

Weber

Gets the SI unit for Magnetic Flux.

public static IBaseUnit Weber { get; }

Property Value

IBaseUnit

The SI unit for Magnetic Flux.

See Also

CreateWeber(double, IPrefix, Action<UnitFormatOptions>)

Methods

Equals(IUnit)

Indicates whether the current object is equal to another object of the same type.

public virtual bool Equals(IUnit other)

Parameters

other IUnit

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.

Operators

implicit operator double(Unit)

Performs an implicit conversion from Unit to double.

public static implicit operator double(Unit unit)

Parameters

unit Unit

The Unit to convert.

Returns

double

A double that is equivalent to unit.

See Also

IUnit