quantity/com.tomtom.quantity/Volume

Volume

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

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

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 Volume's value.

Functions

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

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

Link copied to clipboard
open operator override fun compareTo(other: Volume): Int
Link copied to clipboard
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.

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

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

Link copied to clipboard
fun inLiters(): Double

Expresses the Volume's value in liters.

Link copied to clipboard
fun inMilliliters(): Double

Expresses the Volume's value in milliliters.

Link copied to clipboard
fun inUsGallons(): Double

Expresses the Volume's value in US gallons.

Link copied to clipboard
fun inWholeLiters(): Long

Expresses the Volume's value in liters.

Link copied to clipboard
fun inWholeMilliliters(): Long

Expresses the Volume's value in milliliters.

Link copied to clipboard
fun inWholeUsGallons(): Long

Expresses the Volume's value in US gallons.

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

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

Link copied to clipboard
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.

Link copied to clipboard
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.

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

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

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

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

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

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