Temperature final

final class Temperature extends Quantity<Temperature>

A quantity representing temperature.

Unlike most quantities, temperature conversions involve both a scale factor and a zero-point offset (e.g. Celsius and Fahrenheit share a 9:5 ratio but differ by 32° at zero). This class handles both:

• Scale conversions (toFahrenheit, toCelsius, etc.) adjust for the zero-point offset and are appropriate when converting thermometer readings.
• Degree conversions (toFahrenheitDegrees, toCelsiusDegrees, etc.) skip the offset and are appropriate when converting a difference between two temperatures (e.g. "5 Celsius degrees warmer").

Arithmetic (+, -) operates on degree magnitudes without offset adjustment so that 37°C + 1°C == 38°C rather than trying to account for absolute zero.

Inheritance

Object → Quantity<A extends Quantity<A>> → Temperature

Constructors

Temperature()

Temperature(double value, UnitOfMeasure<Temperature> unit)

Implementation

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

toCelsius no setter

Temperature get toCelsius

Converts this temperature to the Celsius scale.

Implementation

Temperature get toCelsius => _convert(celcius);

toCelsiusDegrees no setter

Temperature get toCelsiusDegrees

Converts this temperature magnitude to Celsius degrees (no offset).

Implementation

Temperature get toCelsiusDegrees => _convert(celcius, withOffset: false);

toFahrenheit no setter

Temperature get toFahrenheit

Converts this temperature to the Fahrenheit scale.

Implementation

Temperature get toFahrenheit => _convert(fahrenheit);

toFahrenheitDegrees no setter

Temperature get toFahrenheitDegrees

Converts this temperature magnitude to Fahrenheit degrees (no offset).

Implementation

Temperature get toFahrenheitDegrees => _convert(fahrenheit, withOffset: false);

toKelvin no setter

Temperature get toKelvin

Converts this temperature to the Kelvin scale.

Implementation

Temperature get toKelvin => _convert(kelvin);

toKelvinDegrees no setter

Temperature get toKelvinDegrees

Converts this temperature magnitude to Kelvin degrees (no offset).

Implementation

Temperature get toKelvinDegrees => _convert(kelvin, withOffset: false);

toRankine no setter

Temperature get toRankine

Converts this temperature to the Rankine scale.

Implementation

Temperature get toRankine => _convert(rankine);

toRankineDegrees no setter

Temperature get toRankineDegrees

Converts this temperature magnitude to Rankine degrees (no offset).

Implementation

Temperature get toRankineDegrees => _convert(rankine, withOffset: false);

unit final inherited

final UnitOfMeasure<Temperature> 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<Temperature> 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() override

double to(UnitOfMeasure<Temperature> uom)

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

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

Implementation

@override
double to(UnitOfMeasure<Temperature> uom) => _convert(uom).value;

toString() override

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.

Implementation

@override
String toString() =>
    unit is Kelvin ? super.toString() : '${value.toStringAsFixed(1)}${unit.symbol}';

Operators

operator +()

Temperature operator +(Temperature that)

Returns the sum of degree magnitudes in the units of this Temperature.

The addend is converted to unit without zero-offset adjustment so that adding temperatures behaves as adding scalar magnitudes.

Implementation

Temperature operator +(Temperature that) =>
    Temperature(value + that._convert(unit, withOffset: false).value, unit);

operator -()

Temperature operator -(Temperature that)

Returns the difference of degree magnitudes in the units of this Temperature.

The subtrahend is converted to unit without zero-offset adjustment.

Implementation

Temperature operator -(Temperature that) =>
    Temperature(value - that._convert(unit, withOffset: false).value, unit);

operator <() inherited

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

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

Implementation

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

Constants

celcius

const Celcius celcius

Unit for degrees Celsius (°C).

Implementation

static const celcius = Celcius._();

fahrenheit

const Fahrenheit fahrenheit

Unit for degrees Fahrenheit (°F).

Implementation

static const fahrenheit = Fahrenheit._();

kelvin

const Kelvin kelvin

Unit for Kelvin (K).

Implementation

static const kelvin = Kelvin._();

rankine

const Rankine rankine

Unit for degrees Rankine (°R).

Implementation

static const rankine = Rankine._();

units

const Set<TemperatureScale> units

All supported Temperature units.

Implementation

static const units = {
  celcius,
  fahrenheit,
  kelvin,
  rankine,
};