Mass final

final class Mass extends Quantity<Mass>

A quantity representing mass.

Inheritance

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

Constructors

Mass()

Mass(double value, UnitOfMeasure<Mass> unit)

Implementation

Mass(super.value, super.unit);

Properties

hashCode no setter inherited

int get hashCode

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

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

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

toCarats no setter

Mass get toCarats

Converts this to carats (ct).

Implementation

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

toGrams no setter

Mass get toGrams

Converts this to grams (g).

Implementation

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

toKilograms no setter

Mass get toKilograms

Converts this to kilograms (kg).

Implementation

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

toKilopounds no setter

Mass get toKilopounds

Converts this to kilopounds (klb).

Implementation

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

toMegapounds no setter

Mass get toMegapounds

Converts this to megapounds (Mlb).

Implementation

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

toMicrograms no setter

Mass get toMicrograms

Converts this to micrograms (mcg).

Implementation

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

toMilligrams no setter

Mass get toMilligrams

Converts this to milligrams (mg).

Implementation

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

toNanograms no setter

Mass get toNanograms

Converts this to nanograms (ng).

Implementation

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

toOunces no setter

Mass get toOunces

Converts this to ounces (oz).

Implementation

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

toPennyweights no setter

Mass get toPennyweights

Converts this to pennyweights (dwt).

Implementation

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

toPounds no setter

Mass get toPounds

Converts this to pounds (lb).

Implementation

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

toStone no setter

Mass get toStone

Converts this to stone (st).

Implementation

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

toTolas no setter

Mass get toTolas

Converts this to tolas.

Implementation

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

toTonnes no setter

Mass get toTonnes

Converts this to metric tonnes (t).

Implementation

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

toTroyGrains no setter

Mass get toTroyGrains

Converts this to troy grains (gr).

Implementation

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

toTroyOunces no setter

Mass get toTroyOunces

Converts this to troy ounces (oz t).

Implementation

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

toTroyPounds no setter

Mass get toTroyPounds

Converts this to troy pounds (lb t).

Implementation

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

unit final inherited

final UnitOfMeasure<Mass> unit

The unit of measure that value is expressed in.

Inherited from Quantity.

Implementation

final UnitOfMeasure<A> unit;

value final inherited

final double value

The raw numeric value of this quantity expressed in unit.

Inherited from Quantity.

Implementation

final double value;

Methods

equivalentTo() inherited

bool equivalentTo(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

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

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

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:

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:

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

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

to() inherited

double to(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

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

toString() inherited

String toString()

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

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

Operators

operator *()

Force operator *(Acceleration that)

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

Implementation

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

operator +()

Mass operator +(Mass that)

Returns the sum of this and that in the units of this Mass.

Implementation

Mass operator +(Mass that) => Mass(value + that.to(unit), unit);

operator -()

Mass operator -(Mass that)

Returns the difference between this and that in the units of this Mass.

Implementation

Mass operator -(Mass that) => Mass(value - that.to(unit), unit);

operator /()

Density operator /(Volume that)

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

Implementation

Density operator /(Volume that) =>
    Density.kilogramsPerCubicMeter(toKilograms.value / that.toCubicMeters.value);

operator <() inherited

bool operator <(Mass that)

Returns true if this quantity is less than that.

that is converted to unit before comparing.

Inherited from Quantity.

Implementation

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

operator <=() inherited

bool operator <=(Mass that)

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

that is converted to unit before comparing.

Inherited from Quantity.

Implementation

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

operator ==() inherited

bool operator ==(Object other)

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

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

operator >() inherited

bool operator >(Mass that)

Returns true if this quantity is greater than that.

that is converted to unit before comparing.

Inherited from Quantity.

Implementation

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

operator >=() inherited

bool operator >=(Mass that)

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

that is converted to unit before comparing.

Inherited from Quantity.

Implementation

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

Static Methods

parse() override

Option<Mass> parse(String s)

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

Implementation

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

Constants

carats

const MassUnit carats

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

Implementation

static const MassUnit carats = Carats._();

grams

const MassUnit grams

Unit for grams (g).

Implementation

static const MassUnit grams = Grams._();

kilograms

const MassUnit kilograms

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

Implementation

static const MassUnit kilograms = Kilograms._();

kilopounds

const MassUnit kilopounds

Unit for kilopounds (klb).

Implementation

static const MassUnit kilopounds = Kilopounds._();

megapounds

const MassUnit megapounds

Unit for megapounds (Mlb).

Implementation

static const MassUnit megapounds = Megapounds._();

micrograms

const MassUnit micrograms

Unit for micrograms (mcg).

Implementation

static const MassUnit micrograms = Micrograms._();

milligrams

const MassUnit milligrams

Unit for milligrams (mg).

Implementation

static const MassUnit milligrams = Milligrams._();

nanograms

const MassUnit nanograms

Unit for nanograms (ng).

Implementation

static const MassUnit nanograms = Nanograms._();

ounces

const MassUnit ounces

Unit for ounces (oz) — avoirdupois.

Implementation

static const MassUnit ounces = Ounces._();

pennyweights

const MassUnit pennyweights

Unit for pennyweights (dwt) — 24 troy grains.

Implementation

static const MassUnit pennyweights = Pennyweights._();

pounds

const MassUnit pounds

Unit for pounds (lb) — avoirdupois.

Implementation

static const MassUnit pounds = Pounds._();

stone

const MassUnit stone

Unit for stone (st) — 14 avoirdupois pounds.

Implementation

static const MassUnit stone = Stone._();

tolas

const MassUnit tolas

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

Implementation

static const MassUnit tolas = Tolas._();

tonnes

const MassUnit tonnes

Unit for metric tonnes (t).

Implementation

static const MassUnit tonnes = Tonnes._();

troyGrains

const MassUnit troyGrains

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

Implementation

static const MassUnit troyGrains = TroyGrains._();

troyOunces

const MassUnit troyOunces

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

Implementation

static const MassUnit troyOunces = TroyOunces._();

troyPounds

const MassUnit troyPounds

Unit for troy pounds (lb t).

Implementation

static const MassUnit troyPounds = TroyPounds._();

units

const Set<MassUnit> units

All supported Mass units.

Implementation

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