api_quantity/com.tomtom.tools.android.api.quantity/Weight

Weight

@Serializable

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

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

Types

object Companion

enum Unit : Enum<Weight.Unit>

The unit of a weight's value.

Functions

open override fun abs(): Weight

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

open operator override fun compareTo(other: Weight): Int

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.

fun inGrams(): Double

Expresses the weight's value in grams.

fun inKilograms(): Double

Expresses the weight's value in kilograms.

fun inLongTons(): Double

Expresses the weight's value in long tons.

fun inMetricTons(): Double

Expresses the weight's value in metric tons.

fun inOunces(): Double

Expresses the weight's value in ounces.

fun inPounds(): Double

Expresses the weight's value in pounds.

fun inShortTons(): Double

Expresses the weight's value in short tons.

fun inTroyOunces(): Double

Expresses the weight's value in troy ounces.

fun inWholeGrams(): Long

Expresses the weight's value in grams rounded down.

inWholeKilograms

fun inWholeKilograms(): Long

Expresses the weight's value in kilograms rounded down.

inWholeLongTons

fun inWholeLongTons(): Long

Expresses the weight's value in long tons rounded down.

inWholeMetricTons

fun inWholeMetricTons(): Long

Expresses the weight's value in metric tons rounded down.

fun inWholeOunces(): Long

Expresses the weight's value in ounces rounded down.

fun inWholePounds(): Long

Expresses the weight's value in pounds rounded down.

inWholeShortTons

fun inWholeShortTons(): Long

Expresses the weight's value in short tons rounded down.

inWholeTroyOunces

fun inWholeTroyOunces(): Long

Expresses the weight's value in troy ounces rounded down.

open operator override fun minus(other: Weight): Weight

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

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.

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.

open override fun toDouble(unit: Weight.Unit): Double

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

open override fun toLong(unit: Weight.Unit): Long

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

open override fun toString(): String

open override fun toString(unit: Weight.Unit, decimals: Int, suffixMode: Quantity.SuffixMode, decimalsMode: Quantity.DecimalsMode): String

Returns a string representation for the value from this with the given unit. Depending on decimalsMode, it will show either exactly or at most decimals amount of decimals after the separator. The unit will be suffixed depending on suffixMode.

open operator override fun unaryMinus(): Weight

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