Struct Quantity

Namespace

Cryville.Measure

Assembly

Cryville.Measure.dll

Physical quantity.

public record struct Quantity : IComparable<Quantity>, IEquatable<Quantity>

Implements

IComparable<Quantity>

IEquatable<Quantity>

Inherited Members

ValueType.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Quantity(double, Unit)

Physical quantity.

public Quantity(double Value, Unit Unit)

Parameters

Value double

The value.

Unit Unit

The unit.

Quantity(float, Unit)

Creates an instance of the Quantity struct.

public Quantity(float value, Unit unit)

Parameters

value float

The value.

unit Unit

The unit.

Properties

Unit

The unit.

public Unit Unit { readonly get; set; }

Property Value

Unit

Value

The value.

public double Value { readonly get; set; }

Property Value

double

Methods

CompareTo(Quantity)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public readonly int CompareTo(Quantity other)

Parameters

other Quantity

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order.

Equals(Quantity)

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

public readonly bool Equals(Quantity other)

Parameters

other Quantity

An object to compare with this object.

Returns

bool

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

GetHashCode()

Returns the hash code for this instance.

public override readonly int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

To(Unit)

Converts the current quantity to a quantity with the specified unit.

public readonly Quantity To(Unit unit)

Parameters

unit Unit

The target unit.

Returns

Quantity

A new quantity converted to unit.

Exceptions

InvalidOperationException

The target unit has a different dimension from the current quantity's unit.

ToString()

Returns the fully qualified type name of this instance.

public override readonly string ToString()

Returns

string

The fully qualified type name.

Operators

operator >(Quantity, Quantity)

public static bool operator >(Quantity left, Quantity right)

Parameters

left Quantity

right Quantity

Returns

bool

operator >=(Quantity, Quantity)

public static bool operator >=(Quantity left, Quantity right)

Parameters

left Quantity

right Quantity

Returns

bool

operator <(Quantity, Quantity)

public static bool operator <(Quantity left, Quantity right)

Parameters

left Quantity

right Quantity

Returns

bool

operator <=(Quantity, Quantity)

public static bool operator <=(Quantity left, Quantity right)

Parameters

left Quantity

right Quantity

Returns

bool