quantity/com.tomtom.quantity/Weight

Weight

data class Weight : Quantity<Weight, Weight.Unit>

A quantity describing weight. (For example, 10 kilograms.)

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
abstract class Unit : UnitBase

The unit of a weight's value.

Functions

Link copied to clipboard
open override fun abs(): Weight

Returns a new instance with the value from this as absolute value.

Link copied to clipboard
open operator override fun compareTo(other: Weight): Int
Link copied to clipboard
open operator override fun div(divisor: Double): Weight
open operator override fun div(divisor: Int): Weight

Returns a new instance with the value from this divided by divisor.

Link copied to clipboard
open override fun format(unit: Weight.Unit): Quantity.FormattedQuantity

Returns a FormattedQuantity representation of the value from this with the given unit.

Link copied to clipboard
fun inGrams(): Double

Expresses the weight's value in grams.

Link copied to clipboard
fun inKilograms(): Double

Expresses the weight's value in kilograms.

Link copied to clipboard
fun inLongTons(): Double

Expresses the weight's value in long tons.

Link copied to clipboard
fun inMetricTons(): Double

Expresses the weight's value in metric tons.

Link copied to clipboard
fun inOunces(): Double

Expresses the weight's value in ounces.

Link copied to clipboard
fun inPounds(): Double

Expresses the weight's value in pounds.

Link copied to clipboard
fun inShortTons(): Double

Expresses the weight's value in short tons.

Link copied to clipboard
fun inTroyOunces(): Double

Expresses the weight's value in troy ounces.

Link copied to clipboard
fun inWholeGrams(): Long

Expresses the weight's value in grams.

Link copied to clipboard
fun inWholeKilograms(): Long

Expresses the weight's value in kilograms.

Link copied to clipboard
fun inWholeLongTons(): Long

Expresses the weight's value in long tons.

Link copied to clipboard
fun inWholeMetricTons(): Long

Expresses the weight's value in metric tons.

Link copied to clipboard
fun inWholeOunces(): Long

Expresses the weight's value in ounces.

Link copied to clipboard
fun inWholePounds(): Long

Expresses the weight's value in pounds.

Link copied to clipboard
fun inWholeShortTons(): Long

Expresses the weight's value in short tons.

Link copied to clipboard
fun inWholeTroyOunces(): Long

Expresses the weight's value in troy ounces.

Link copied to clipboard
open operator override fun minus(other: Weight): Weight

Returns a new instance that has other's value subtracted from this.

Link copied to clipboard
open operator override fun plus(other: Weight): Weight

Returns a new instance with a value equal to the sum of values from this and other.

Link copied to clipboard
open operator override fun times(factor: Double): Weight
open operator override fun times(factor: Int): Weight

Returns a new instance with the value from this multiplied by factor.

Link copied to clipboard
open override fun toDouble(unit: Weight.Unit): Double

Expresses the value of this under the given unit as a Double.

Link copied to clipboard
open override fun toLong(unit: Weight.Unit): Long

Expresses the value of this under the given unit as a Long.

Link copied to clipboard
open operator override fun unaryMinus(): Weight

Returns a new instance with the value from this as negative.