Ribs

Appearance

ribs_units›Classes›Energy

Energy final ​

final class Energy extends Quantity<Energy>

A quantity representing energy or work.

Inheritance

Object → Quantity<A extends Quantity<A>> → Energy

Constructors ​

Energy() ​

Energy(double value, UnitOfMeasure<Energy> unit)
Implementation
dart
Energy(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
dart
@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
dart
external Type get runtimeType;

toBtu no setter ​

Energy get toBtu

Converts this to British Thermal Units (BTU).

Implementation
dart
Energy get toBtu => to(btu).btu;

toCalories no setter ​

Energy get toCalories

Converts this to calories (cal).

Implementation
dart
Energy get toCalories => to(calories).calories;

toElectronvolts no setter ​

Energy get toElectronvolts

Converts this to electronvolts (eV).

Implementation
dart
Energy get toElectronvolts => to(electronvolts).electronvolts;

toGigajoules no setter ​

Energy get toGigajoules

Converts this to gigajoules (GJ).

Implementation
dart
Energy get toGigajoules => to(gigajoules).gigajoules;

toGigawattHours no setter ​

Energy get toGigawattHours

Converts this to gigawatt-hours (GWh).

Implementation
dart
Energy get toGigawattHours => to(gigawattHours).gigawattHours;

toJoules no setter ​

Energy get toJoules

Converts this to joules (J).

Implementation
dart
Energy get toJoules => to(joules).joules;

toKilocalories no setter ​

Energy get toKilocalories

Converts this to kilocalories (kcal).

Implementation
dart
Energy get toKilocalories => to(kilocalories).kilocalories;

toKilojoules no setter ​

Energy get toKilojoules

Converts this to kilojoules (kJ).

Implementation
dart
Energy get toKilojoules => to(kilojoules).kilojoules;

toKilowattHours no setter ​

Energy get toKilowattHours

Converts this to kilowatt-hours (kWh).

Implementation
dart
Energy get toKilowattHours => to(kilowattHours).kilowattHours;

toMegajoules no setter ​

Energy get toMegajoules

Converts this to megajoules (MJ).

Implementation
dart
Energy get toMegajoules => to(megajoules).megajoules;

toMegawattHours no setter ​

Energy get toMegawattHours

Converts this to megawatt-hours (MWh).

Implementation
dart
Energy get toMegawattHours => to(megawattHours).megawattHours;

toMillijoules no setter ​

Energy get toMillijoules

Converts this to millijoules (mJ).

Implementation
dart
Energy get toMillijoules => to(millijoules).millijoules;

toTerajoules no setter ​

Energy get toTerajoules

Converts this to terajoules (TJ).

Implementation
dart
Energy get toTerajoules => to(terajoules).terajoules;

toWattHours no setter ​

Energy get toWattHours

Converts this to watt-hours (Wh).

Implementation
dart
Energy get toWattHours => to(wattHours).wattHours;

unit final inherited ​

final UnitOfMeasure<Energy> unit

The unit of measure that value is expressed in.

Inherited from Quantity.

Implementation
dart
final UnitOfMeasure<A> unit;

value final inherited ​

final double value

The raw numeric value of this quantity expressed in unit.

Inherited from Quantity.

Implementation
dart
final double value;

Methods ​

equivalentTo() inherited ​

bool equivalentTo(Quantity<Energy> 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 ​

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:

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 ​

double to(UnitOfMeasure<Energy> 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 ​

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
dart
@override
String toString() => '$value ${unit.symbol}';

Operators ​

operator +() ​

Energy operator +(Energy that)

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

Implementation
dart
Energy operator +(Energy that) => Energy(value + that.to(unit), unit);

operator -() ​

Energy operator -(Energy that)

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

Implementation
dart
Energy operator -(Energy that) => Energy(value - that.to(unit), unit);

operator /() ​

Power operator /(Time that)

Divides this energy by that time to produce Power in watts.

Implementation
dart
Power operator &#47;(Time that) => Power.watts(toJoules.value &#47; that.toSeconds.value);

operator <() inherited ​

bool operator <(Energy that)

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 ​

bool operator <=(Energy that)

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 ​

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

operator >() inherited ​

bool operator >(Energy that)

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 ​

bool operator >=(Energy that)

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<Energy> parse(String s)

Parses s into an Energy, returning None if parsing fails.

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

Constants ​

btu ​

const EnergyUnit btu

Unit for British Thermal Units (BTU).

Implementation
dart
static const EnergyUnit btu = BritishThermalUnits._();

calories ​

const EnergyUnit calories

Unit for calories (cal) — thermochemical calorie.

Implementation
dart
static const EnergyUnit calories = Calories._();

electronvolts ​

const EnergyUnit electronvolts

Unit for electronvolts (eV).

Implementation
dart
static const EnergyUnit electronvolts = Electronvolts._();

gigajoules ​

const EnergyUnit gigajoules

Unit for gigajoules (GJ).

Implementation
dart
static const EnergyUnit gigajoules = Gigajoules._();

gigawattHours ​

const EnergyUnit gigawattHours

Unit for gigawatt-hours (GWh).

Implementation
dart
static const EnergyUnit gigawattHours = GigawattHours._();

joules ​

const EnergyUnit joules

Unit for joules (J) — the SI unit of energy.

Implementation
dart
static const EnergyUnit joules = Joules._();

kilocalories ​

const EnergyUnit kilocalories

Unit for kilocalories (kcal) — food calories.

Implementation
dart
static const EnergyUnit kilocalories = Kilocalories._();

kilojoules ​

const EnergyUnit kilojoules

Unit for kilojoules (kJ).

Implementation
dart
static const EnergyUnit kilojoules = Kilojoules._();

kilowattHours ​

const EnergyUnit kilowattHours

Unit for kilowatt-hours (kWh).

Implementation
dart
static const EnergyUnit kilowattHours = KilowattHours._();

megajoules ​

const EnergyUnit megajoules

Unit for megajoules (MJ).

Implementation
dart
static const EnergyUnit megajoules = Megajoules._();

megawattHours ​

const EnergyUnit megawattHours

Unit for megawatt-hours (MWh).

Implementation
dart
static const EnergyUnit megawattHours = MegawattHours._();

millijoules ​

const EnergyUnit millijoules

Unit for millijoules (mJ).

Implementation
dart
static const EnergyUnit millijoules = Millijoules._();

terajoules ​

const EnergyUnit terajoules

Unit for terajoules (TJ).

Implementation
dart
static const EnergyUnit terajoules = Terajoules._();

units ​

const Set<EnergyUnit> units

All supported Energy units.

Implementation
dart
static const units = {
  joules,
  millijoules,
  kilojoules,
  megajoules,
  gigajoules,
  terajoules,
  wattHours,
  kilowattHours,
  megawattHours,
  gigawattHours,
  btu,
  calories,
  kilocalories,
  electronvolts,
};

wattHours ​

const EnergyUnit wattHours

Unit for watt-hours (Wh).

Implementation
dart
static const EnergyUnit wattHours = WattHours._();