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

Volume

@Serializable

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

A quantity describing volume. (For example, 10 liters.)

Types

object Companion

enum Unit : Enum<Volume.Unit>

The unit of a volume's value.

Functions

open override fun abs(): Volume

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

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

open operator override fun div(divisor: Double): Volume

open operator override fun div(divisor: Int): Volume

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

fun inLiters(): Double

Expresses the volume's value in liters.

fun inMilliliters(): Double

Expresses the volume's value in milliliters.

fun inUsGallons(): Double

Expresses the volume's value in US gallons.

fun inWholeLiters(): Long

Expresses the volume's value in liters rounded down.

inWholeMilliliters

fun inWholeMilliliters(): Long

Expresses the volume's value in milliliters rounded down.

inWholeUsGallons

fun inWholeUsGallons(): Long

Expresses the volume's value in US gallons rounded down.

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

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

open operator override fun plus(other: Volume): Volume

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

open operator override fun times(factor: Double): Volume

open operator override fun times(factor: Int): Volume

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

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

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

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

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

open override fun toString(): String

open override fun toString(unit: Volume.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(): Volume

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