Volume final

final class Volume extends Quantity<Volume>

A quantity representing three-dimensional volume.

Inheritance

Object → Quantity<A extends Quantity<A>> → Volume

Constructors

Volume()

Volume(double value, UnitOfMeasure<Volume> unit)

Implementation

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

toCentilitres no setter

Volume get toCentilitres

Converts this to centilitres (cl).

Implementation

Volume get toCentilitres => to(centilitres).centilitres;

toCubicFeet no setter

Volume get toCubicFeet

Converts this to cubic feet (ft³).

Implementation

Volume get toCubicFeet => to(cubicFeet).cubicFeet;

toCubicInches no setter

Volume get toCubicInches

Converts this to cubic inches (in³).

Implementation

Volume get toCubicInches => to(cubicInches).cubicInches;

toCubicMeters no setter

Volume get toCubicMeters

Converts this to cubic meters (m³).

Implementation

Volume get toCubicMeters => to(cubicMeters).cubicMeters;

toCubicUsMiles no setter

Volume get toCubicUsMiles

Converts this to cubic US miles (mi³).

Implementation

Volume get toCubicUsMiles => to(cubicUsMiles).cubicUsMiles;

toCubicYards no setter

Volume get toCubicYards

Converts this to cubic yards (yd³).

Implementation

Volume get toCubicYards => to(cubicYards).cubicYards;

toDecilitres no setter

Volume get toDecilitres

Converts this to decilitres (dl).

Implementation

Volume get toDecilitres => to(decilitres).decilitres;

toFluidOunces no setter

Volume get toFluidOunces

Converts this to fluid ounces (oz).

Implementation

Volume get toFluidOunces => to(fluidOunces).fluidOunces;

toHectolitres no setter

Volume get toHectolitres

Converts this to hectolitres (hl).

Implementation

Volume get toHectolitres => to(hectolitres).hectolitres;

toLitres no setter

Volume get toLitres

Converts this to litres (L).

Implementation

Volume get toLitres => to(litres).litres;

toMicrolitres no setter

Volume get toMicrolitres

Converts this to microlitres (µl).

Implementation

Volume get toMicrolitres => to(microlitres).microlitres;

toMillilitres no setter

Volume get toMillilitres

Converts this to millilitres (ml).

Implementation

Volume get toMillilitres => to(millilitres).millilitres;

toNanolitres no setter

Volume get toNanolitres

Converts this to nanolitres (nl).

Implementation

Volume get toNanolitres => to(nanolitres).nanolitres;

toTablespoons no setter

Volume get toTablespoons

Converts this to tablespoons (tbsp).

Implementation

Volume get toTablespoons => to(tablespoons).tablespoons;

toTeaspoons no setter

Volume get toTeaspoons

Converts this to teaspoons (tsp).

Implementation

Volume get toTeaspoons => to(teaspoons).teaspoons;

toUsCups no setter

Volume get toUsCups

Converts this to US cups (c).

Implementation

Volume get toUsCups => to(usCups).usCups;

toUsGallons no setter

Volume get toUsGallons

Converts this to US gallons (gal).

Implementation

Volume get toUsGallons => to(usGallons).usGallons;

toUsPints no setter

Volume get toUsPints

Converts this to US pints (pt).

Implementation

Volume get toUsPints => to(usPints).usPints;

toUsQuarts no setter

Volume get toUsQuarts

Converts this to US quarts (qt).

Implementation

Volume get toUsQuarts => to(usQuarts).usQuarts;

unit final inherited

final UnitOfMeasure<Volume> 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<Volume> 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<Volume> 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 +()

Volume operator +(Volume that)

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

Implementation

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

operator -()

Volume operator -(Volume that)

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

Implementation

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

operator /()

VolumeFlow operator /(Time that)

Divides this volume by that time to produce a VolumeFlow in m³/s.

Implementation

VolumeFlow operator /(Time that) =>
    VolumeFlow.cubicMetersPerSecond(toCubicMeters.value / that.toSeconds.value);

operator <() inherited

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

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

Implementation

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

Constants

centilitres

const Centilitres centilitres

Unit for centilitres (cl).

Implementation

static const centilitres = Centilitres._();

cubicFeet

const CubicFeet cubicFeet

Unit for cubic feet (ft³).

Implementation

static const cubicFeet = CubicFeet._();

cubicInches

const CubicInches cubicInches

Unit for cubic inches (in³).

Implementation

static const cubicInches = CubicInches._();

cubicMeters

const CubicMeters cubicMeters

Unit for cubic meters (m³).

Implementation

static const cubicMeters = CubicMeters._();

cubicUsMiles

const CubicUsMiles cubicUsMiles

Unit for cubic US miles (mi³).

Implementation

static const cubicUsMiles = CubicUsMiles._();

cubicYards

const CubicYards cubicYards

Unit for cubic yards (yd³).

Implementation

static const cubicYards = CubicYards._();

decilitres

const Decilitres decilitres

Unit for decilitres (dl).

Implementation

static const decilitres = Decilitres._();

fluidOunces

const FluidOunces fluidOunces

Unit for fluid ounces (oz).

Implementation

static const fluidOunces = FluidOunces._();

hectolitres

const Hectolitres hectolitres

Unit for hectolitres (hl).

Implementation

static const hectolitres = Hectolitres._();

litres

const Litres litres

Unit for litres (L).

Implementation

static const litres = Litres._();

microlitres

const Microlitres microlitres

Unit for microlitres (µl).

Implementation

static const microlitres = Microlitres._();

millilitres

const Millilitres millilitres

Unit for millilitres (ml).

Implementation

static const millilitres = Millilitres._();

nanolitres

const Nanolitres nanolitres

Unit for nanolitres (nl).

Implementation

static const nanolitres = Nanolitres._();

tablespoons

const Tablespoons tablespoons

Unit for tablespoons (tbsp).

Implementation

static const tablespoons = Tablespoons._();

teaspoons

const Teaspoons teaspoons

Unit for teaspoons (tsp).

Implementation

static const teaspoons = Teaspoons._();

units

const Set<VolumeUnit> units

All supported Volume units.

Implementation

static const units = {
  cubicMeters,
  litres,
  nanolitres,
  microlitres,
  millilitres,
  centilitres,
  decilitres,
  hectolitres,
  cubicUsMiles,
  cubicYards,
  cubicFeet,
  cubicInches,
  usGallons,
  usQuarts,
  usPints,
  usCups,
  fluidOunces,
  tablespoons,
  teaspoons,
};

usCups

const UsCups usCups

Unit for US cups (c).

Implementation

static const usCups = UsCups._();

usGallons

const UsGallons usGallons

Unit for US gallons (gal).

Implementation

static const usGallons = UsGallons._();

usPints

const UsPints usPints

Unit for US pints (pt).

Implementation

static const usPints = UsPints._();

usQuarts

const UsQuarts usQuarts

Unit for US quarts (qt).

Implementation

static const usQuarts = UsQuarts._();