Length final

final class Length extends Quantity<Length>

A quantity representing length or distance.

Inheritance

Object → Quantity<A extends Quantity<A>> → Length

Constructors

Length()

Length(double value, UnitOfMeasure<Length> unit)

Implementation

Length(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;

toCentimeters no setter

Length get toCentimeters

Converts this to centimeters (cm).

Implementation

Length get toCentimeters => to(centimeters).centimeters;

toDecameters no setter

Length get toDecameters

Converts this to decameters (dam).

Implementation

Length get toDecameters => to(decameters).decameters;

toDecimeters no setter

Length get toDecimeters

Converts this to decimeters (dm).

Implementation

Length get toDecimeters => to(decimeters).decimeters;

toFeet no setter

Length get toFeet

Converts this to feet (ft).

Implementation

Length get toFeet => to(feet).feet;

toHectometers no setter

Length get toHectometers

Converts this to hectometers (hm).

Implementation

Length get toHectometers => to(hectometers).hectometers;

toInches no setter

Length get toInches

Converts this to inches (in).

Implementation

Length get toInches => to(inches).inches;

toKilometers no setter

Length get toKilometers

Converts this to kilometers (km).

Implementation

Length get toKilometers => to(kilometers).kilometers;

toMeters no setter

Length get toMeters

Converts this to meters (m).

Implementation

Length get toMeters => to(meters).meters;

toMicrons no setter

Length get toMicrons

Converts this to microns (µm).

Implementation

Length get toMicrons => to(microns).microns;

toMillimeters no setter

Length get toMillimeters

Converts this to millimeters (mm).

Implementation

Length get toMillimeters => to(millimeters).millimeters;

toNanometers no setter

Length get toNanometers

Converts this to nanometers (nm).

Implementation

Length get toNanometers => to(nanometers).nanometers;

toNauticalMiles no setter

Length get toNauticalMiles

Converts this to nautical miles (nmi).

Implementation

Length get toNauticalMiles => to(nauticalMiles).nauticalMiles;

toUsMiles no setter

Length get toUsMiles

Converts this to US miles (mi).

Implementation

Length get toUsMiles => to(usMiles).usMiles;

toYards no setter

Length get toYards

Converts this to yards (yd).

Implementation

Length get toYards => to(yards).yards;

unit final inherited

final UnitOfMeasure<Length> 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<Length> 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<Length> 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 *()

Area operator *(Length that)

Multiplies this length by that to produce an Area.

The result unit is chosen to match the unit of this where possible (e.g. feet * feet → squareFeet); otherwise defaults to square meters.

Implementation

Area operator *(Length that) {
  if (unit == centimeters) {
    return Area.squareCentimeters(value * that.toCentimeters.value);
  } else if (unit == kilometers) {
    return Area.squareKilometers(value * that.toKilometers.value);
  } else if (unit == usMiles) {
    return Area.squareUsMiles(value * that.toUsMiles.value);
  } else if (unit == yards) {
    return Area.squareYards(value * that.toYards.value);
  } else if (unit == feet) {
    return Area.squareFeet(value * that.toFeet.value);
  } else if (unit == inches) {
    return Area.squareInches(value * that.toInches.value);
  } else {
    return Area.squareMeters(toMeters.value * that.toMeters.value);
  }
}

operator +()

Length operator +(Length that)

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

Implementation

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

operator -()

Length operator -(Length that)

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

Implementation

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

operator /()

Velocity operator /(Time that)

Divides this length by that time to produce a Velocity in m/s.

Implementation

Velocity operator /(Time that) => Velocity.metersPerSecond(toMeters.value / that.toSeconds.value);

operator <() inherited

bool operator <(Length 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 <=(Length 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 >(Length 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 >=(Length 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<Length> parse(String s)

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

Implementation

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

Constants

centimeters

const LengthUnit centimeters

Unit for centimeters (cm).

Implementation

static const LengthUnit centimeters = Centimeters._();

decameters

const LengthUnit decameters

Unit for decameters (dam).

Implementation

static const LengthUnit decameters = Decameters._();

decimeters

const LengthUnit decimeters

Unit for decimeters (dm).

Implementation

static const LengthUnit decimeters = Decimeters._();

feet

const LengthUnit feet

Unit for feet (ft).

Implementation

static const LengthUnit feet = Feet._();

FeetConversionFactor

const double FeetConversionFactor

Conversion factor from feet to meters.

Implementation

static const FeetConversionFactor = 3.048006096e-1;

hectometers

const LengthUnit hectometers

Unit for hectometers (hm).

Implementation

static const LengthUnit hectometers = Hectometers._();

inches

const LengthUnit inches

Unit for inches (in).

Implementation

static const LengthUnit inches = Inches._();

kilometers

const LengthUnit kilometers

Unit for kilometers (km).

Implementation

static const LengthUnit kilometers = Kilometers._();

meters

const LengthUnit meters

Unit for meters (m) — the SI base unit of length.

Implementation

static const LengthUnit meters = Meters._();

microns

const LengthUnit microns

Unit for microns / micrometers (µm).

Implementation

static const LengthUnit microns = Microns._();

millimeters

const LengthUnit millimeters

Unit for millimeters (mm).

Implementation

static const LengthUnit millimeters = Millimeters._();

nanometers

const LengthUnit nanometers

Unit for nanometers (nm).

Implementation

static const LengthUnit nanometers = Nanometers._();

nauticalMiles

const LengthUnit nauticalMiles

Unit for nautical miles (nmi).

Implementation

static const LengthUnit nauticalMiles = NauticalMiles._();

units

const Set<LengthUnit> units

All supported Length units.

Implementation

static const units = {
  nanometers,
  microns,
  millimeters,
  centimeters,
  decimeters,
  meters,
  decameters,
  hectometers,
  kilometers,
  inches,
  feet,
  yards,
  usMiles,
  nauticalMiles,
};

usMiles

const LengthUnit usMiles

Unit for US survey miles (mi).

Implementation

static const LengthUnit usMiles = UsMiles._();

yards

const LengthUnit yards

Unit for yards (yd).

Implementation

static const LengthUnit yards = Yards._();