Distance

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

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum Unit : Enum<Distance.Unit>

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
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
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 rounded down.

Link copied to clipboard
fun inWholeFeet(): Long

Expresses the distance's value in feet rounded down.

Link copied to clipboard
fun inWholeInches(): Long

Expresses the distance's value in inches rounded down.

Link copied to clipboard
fun inWholeKilometers(): Long

Expresses the distance's value in kilometers rounded down.

Link copied to clipboard
fun inWholeMeters(): Long

Expresses the distance's value in meters rounded down.

Link copied to clipboard
fun inWholeMiles(): Long

Expresses the distance's value in miles rounded down.

Link copied to clipboard
fun inWholeMillimeters(): Long

Expresses the distance's value in millimeters rounded down.

Link copied to clipboard
fun inWholeYards(): Long

Expresses the distance's value in yards rounded down.

Link copied to clipboard
fun inYards(): Double

Expresses the distance's value in yards.

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
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 override fun toString(unit: Distance.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.

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

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

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)