common:core/com.tomtom.kotlin.quantity/Speed

Speed

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

A quantity describing speed. (For example, 10 kilometers per hour.)

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

object Companion

enum Unit : Enum<Speed.Unit>

The unit of a speed's value.

Functions

open override fun abs(): Speed

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

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

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

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

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

inKilometersPerHour

fun inKilometersPerHour(): Double

Expresses the speed's value in kilometers per hour.

inMetersPerHour

fun inMetersPerHour(): Double

Expresses the speed's value in meters per hour.

inMetersPerSecond

fun inMetersPerSecond(): Double

Expresses the speed's value in meters per second.

fun inMilesPerHour(): Double

Expresses the speed's value in miles per hour.

inWholeKilometersPerHour

fun inWholeKilometersPerHour(): Long

Expresses the speed's value in kilometers per hour.

inWholeMetersPerHour

fun inWholeMetersPerHour(): Long

Expresses the speed's value in meters per hour.

inWholeMetersPerSecond

fun inWholeMetersPerSecond(): Long

Expresses the speed's value in meters per second.

inWholeMilesPerHour

fun inWholeMilesPerHour(): Long

Expresses the speed's value in miles per hour.

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

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

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

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

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

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

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

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

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

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

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

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

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