quantity/com.tomtom.quantity/Distance

Distance

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

A quantity describing a distance. (For example, 10 kilometers.)

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

Functions

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

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

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

open operator override fun div(divisor: Double): Distance
open operator override fun div(divisor: Int): Distance

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

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

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

Link copied to clipboard
fun inCentimeters(): Double

Expresses the distance's value in centimeters.

Link copied to clipboard
fun inFeet(): Double

Expresses the distance's value in feet.

Link copied to clipboard
fun inInches(): Double

Expresses the distance's value in inches.

Link copied to clipboard
fun inKilometers(): Double

Expresses the distance's value in kilometers.

Link copied to clipboard
fun inMeters(): Double

Expresses the distance's value in meters.

Link copied to clipboard
fun inMiles(): Double

Expresses the distance's value in miles.

Link copied to clipboard
fun inMillimeters(): Double

Expresses the distance's value in millimeters.

Link copied to clipboard
fun inWholeCentimeters(): Long

Expresses the distance's value in centimeters.

Link copied to clipboard
fun inWholeFeet(): Long

Expresses the distance's value in feet.

Link copied to clipboard
fun inWholeInches(): Long

Expresses the distance's value in inches.

Link copied to clipboard
fun inWholeKilometers(): Long

Expresses the distance's value in kilometers.

Link copied to clipboard
fun inWholeMeters(): Long

Expresses the distance's value in meters.

Link copied to clipboard
fun inWholeMiles(): Long

Expresses the distance's value in miles.

Link copied to clipboard
fun inWholeMillimeters(): Long

Expresses the distance's value in millimeters.

Link copied to clipboard
fun inWholeYards(): Long

Expresses the distance's value in yards.

Link copied to clipboard
fun inYards(): Double

Expresses the distance's value in yards.

Link copied to clipboard
fun isZero(): Boolean
Link copied to clipboard
open operator override fun minus(other: Distance): Distance

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

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

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

Link copied to clipboard
operator fun times(factor: Distance): Double

open operator override fun times(factor: Double): Distance
open operator override fun times(factor: Int): Distance

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

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

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

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

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

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

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