Ribs

Appearance

ribs_units›Classes›Mass

Mass final ​

finalclassMassextendsQuantity<Mass>

A quantity representing mass.

Inheritance

Object → Quantity<A extends Quantity<A>> → Mass

Constructors ​

Mass() ​

Mass(doublevalue,UnitOfMeasure<Mass>unit)
Implementation
dart
Mass(super.value, super.unit);

Properties ​

hashCode no setter inherited ​

intgethashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Quantity.

Implementation
dart
@override
int get hashCode => Object.hash(value, unit);

runtimeType no setter inherited ​

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

toCarats no setter ​

MassgettoCarats

Converts this to carats (ct).

Implementation
dart
Mass get toCarats => to(carats).carats;

toGrams no setter ​

MassgettoGrams

Converts this to grams (g).

Implementation
dart
Mass get toGrams => to(grams).grams;

toKilograms no setter ​

MassgettoKilograms

Converts this to kilograms (kg).

Implementation
dart
Mass get toKilograms => to(kilograms).kilograms;

toKilopounds no setter ​

MassgettoKilopounds

Converts this to kilopounds (klb).

Implementation
dart
Mass get toKilopounds => to(kilopounds).kilopounds;

toMegapounds no setter ​

MassgettoMegapounds

Converts this to megapounds (Mlb).

Implementation
dart
Mass get toMegapounds => to(megapounds).megapounds;

toMicrograms no setter ​

MassgettoMicrograms

Converts this to micrograms (mcg).

Implementation
dart
Mass get toMicrograms => to(micrograms).micrograms;

toMilligrams no setter ​

MassgettoMilligrams

Converts this to milligrams (mg).

Implementation
dart
Mass get toMilligrams => to(milligrams).milligrams;

toNanograms no setter ​

MassgettoNanograms

Converts this to nanograms (ng).

Implementation
dart
Mass get toNanograms => to(nanograms).nanograms;

toOunces no setter ​

MassgettoOunces

Converts this to ounces (oz).

Implementation
dart
Mass get toOunces => to(ounces).ounces;

toPennyweights no setter ​

MassgettoPennyweights

Converts this to pennyweights (dwt).

Implementation
dart
Mass get toPennyweights => to(pennyweights).pennyweights;

toPounds no setter ​

MassgettoPounds

Converts this to pounds (lb).

Implementation
dart
Mass get toPounds => to(pounds).pounds;

toStone no setter ​

MassgettoStone

Converts this to stone (st).

Implementation
dart
Mass get toStone => to(stone).stone;

toTolas no setter ​

MassgettoTolas

Converts this to tolas.

Implementation
dart
Mass get toTolas => to(tolas).tolas;

toTonnes no setter ​

MassgettoTonnes

Converts this to metric tonnes (t).

Implementation
dart
Mass get toTonnes => to(tonnes).tonnes;

toTroyGrains no setter ​

MassgettoTroyGrains

Converts this to troy grains (gr).

Implementation
dart
Mass get toTroyGrains => to(troyGrains).troyGrains;

toTroyOunces no setter ​

MassgettoTroyOunces

Converts this to troy ounces (oz t).

Implementation
dart
Mass get toTroyOunces => to(troyOunces).troyOunces;

toTroyPounds no setter ​

MassgettoTroyPounds

Converts this to troy pounds (lb t).

Implementation
dart
Mass get toTroyPounds => to(troyPounds).troyPounds;

unit final inherited ​

finalUnitOfMeasure<Mass>unit

The unit of measure that value is expressed in.

Inherited from Quantity.

Implementation
dart
final UnitOfMeasure<A> unit;

value final inherited ​

finaldoublevalue

The raw numeric value of this quantity expressed in unit.

Inherited from Quantity.

Implementation
dart
final double value;

Methods ​

equivalentTo() inherited ​

boolequivalentTo(Quantity<Mass>other)

Returns true if this quantity represents the same physical magnitude as other, regardless of which unit each is expressed in.

Inherited from Quantity.

Implementation
dart
bool equivalentTo(Quantity<A> other) => other.to(unit) == value;

noSuchMethod() inherited ​

dynamicnoSuchMethod(Invocationinvocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

to() inherited ​

doubleto(UnitOfMeasure<Mass>uom)

Converts this quantity to uom and returns the raw double value.

If uom equals unit, the current value is returned unchanged.

Inherited from Quantity.

Implementation
dart
double to(UnitOfMeasure<A> uom) => uom == unit ? value : uom.convertTo(unit.convertFrom(value));

toString() inherited ​

StringtoString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Quantity.

Implementation
dart
@override
String toString() => '$value ${unit.symbol}';

Operators ​

operator *() ​

Forceoperator *(Accelerationthat)

Multiplies this mass by that acceleration to produce Force in newtons.

Implementation
dart
Force operator *(Acceleration that) =>
    Force.newtons(toKilograms.value * that.toMetersPerSecondSquared.value);

operator +() inherited ​

Massoperator +(Massthat)

Returns the sum of this quantity and that, expressed in unit.

that is converted to unit before adding, so mixed-unit addition is safe.

Inherited from Quantity.

Implementation
dart
A operator +(A that) => unit.call(value + that.to(unit));

operator -() inherited ​

Massoperator -(Massthat)

Returns the difference of this quantity and that, expressed in unit.

that is converted to unit before subtracting, so mixed-unit subtraction is safe.

Inherited from Quantity.

Implementation
dart
A operator -(A that) => unit.call(value - that.to(unit));

operator /() ​

Densityoperator /(Volumethat)

Divides this mass by that volume to produce Density in kg/m³.

Implementation
dart
Density operator &#47;(Volume that) =>
    Density.kilogramsPerCubicMeter(toKilograms.value &#47; that.toCubicMeters.value);

operator <() inherited ​

booloperator <(Massthat)

Returns true if this quantity is less than that.

that is converted to unit before comparing.

Inherited from Quantity.

Implementation
dart
bool operator <(A that) => value < that.to(unit);

operator <=() inherited ​

booloperator <=(Massthat)

Returns true if this quantity is less than or equal to that.

that is converted to unit before comparing.

Inherited from Quantity.

Implementation
dart
bool operator <=(A that) => value <= that.to(unit);

operator ==() inherited ​

booloperator ==(Objectother)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Quantity.

Implementation
dart
@override
bool operator ==(Object other) =>
    identical(this, other) ||
    (other is Quantity<A> && other.value == value && other.unit == unit);

operator >() inherited ​

booloperator >(Massthat)

Returns true if this quantity is greater than that.

that is converted to unit before comparing.

Inherited from Quantity.

Implementation
dart
bool operator >(A that) => value > that.to(unit);

operator >=() inherited ​

booloperator >=(Massthat)

Returns true if this quantity is greater than or equal to that.

that is converted to unit before comparing.

Inherited from Quantity.

Implementation
dart
bool operator >=(A that) => value >= that.to(unit);

Static Methods ​

parse() override ​

Option<Mass>parse(Strings)

Parses s into a Mass, returning None if parsing fails.

Implementation
dart
static Option<Mass> parse(String s) => Quantity.parse(s, units);

Constants ​

carats ​

constMassUnitcarats

Unit for carats (ct) — used for gemstones; 1 ct = 200 mg.

Implementation
dart
static const MassUnit carats = Carats._();

grams ​

constMassUnitgrams

Unit for grams (g).

Implementation
dart
static const MassUnit grams = Grams._();

kilograms ​

constMassUnitkilograms

Unit for kilograms (kg) — the SI base unit of mass.

Implementation
dart
static const MassUnit kilograms = Kilograms._();

kilopounds ​

constMassUnitkilopounds

Unit for kilopounds (klb).

Implementation
dart
static const MassUnit kilopounds = Kilopounds._();

megapounds ​

constMassUnitmegapounds

Unit for megapounds (Mlb).

Implementation
dart
static const MassUnit megapounds = Megapounds._();

micrograms ​

constMassUnitmicrograms

Unit for micrograms (mcg).

Implementation
dart
static const MassUnit micrograms = Micrograms._();

milligrams ​

constMassUnitmilligrams

Unit for milligrams (mg).

Implementation
dart
static const MassUnit milligrams = Milligrams._();

nanograms ​

constMassUnitnanograms

Unit for nanograms (ng).

Implementation
dart
static const MassUnit nanograms = Nanograms._();

ounces ​

constMassUnitounces

Unit for ounces (oz) — avoirdupois.

Implementation
dart
static const MassUnit ounces = Ounces._();

pennyweights ​

constMassUnitpennyweights

Unit for pennyweights (dwt) — 24 troy grains.

Implementation
dart
static const MassUnit pennyweights = Pennyweights._();

pounds ​

constMassUnitpounds

Unit for pounds (lb) — avoirdupois.

Implementation
dart
static const MassUnit pounds = Pounds._();

stone ​

constMassUnitstone

Unit for stone (st) — 14 avoirdupois pounds.

Implementation
dart
static const MassUnit stone = Stone._();

tolas ​

constMassUnittolas

Unit for tolas — a traditional South Asian unit of mass.

Implementation
dart
static const MassUnit tolas = Tolas._();

tonnes ​

constMassUnittonnes

Unit for metric tonnes (t).

Implementation
dart
static const MassUnit tonnes = Tonnes._();

troyGrains ​

constMassUnittroyGrains

Unit for troy grains (gr) — the smallest unit in the troy system.

Implementation
dart
static const MassUnit troyGrains = TroyGrains._();

troyOunces ​

constMassUnittroyOunces

Unit for troy ounces (oz t) — used for precious metals.

Implementation
dart
static const MassUnit troyOunces = TroyOunces._();

troyPounds ​

constMassUnittroyPounds

Unit for troy pounds (lb t).

Implementation
dart
static const MassUnit troyPounds = TroyPounds._();

units ​

constSet<MassUnit>units

All supported Mass units.

Implementation
dart
static const units = {
  grams,
  nanograms,
  micrograms,
  milligrams,
  kilograms,
  tonnes,
  ounces,
  pounds,
  kilopounds,
  megapounds,
  stone,
  troyGrains,
  pennyweights,
  troyOunces,
  troyPounds,
  tolas,
  carats,
};