com.tomtom.quantity:quantity/com.tomtom.quantity/Speed

Speed

@JvmInline
value class Speed : Quantity<Speed, Speed.Unit>

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard
abstract class Unit : UnitBase

Speed units.

Properties

Link copied to clipboard
open override val rawValue: Long

Raw unformatted value.

Functions

Link copied to clipboard
open operator override fun div(divisor: Speed): Double
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.

Link copied to clipboard
fun inKilometersPerHour(): Double

Expresses the speed's value in kilometers per hour.

Link copied to clipboard
fun inMetersPerHour(): Double

Expresses the speed's value in meters per hour.

Link copied to clipboard
fun inMetersPerSecond(): Double

Expresses the speed's value in meters per second.

Link copied to clipboard
fun inMilesPerHour(): Double

Expresses the speed's value in miles per hour.

Link copied to clipboard
fun inWholeKilometersPerHour(): Long

Expresses the speed's value in kilometers per hour.

Link copied to clipboard
fun inWholeMetersPerHour(): Long

Expresses the speed's value in meters per hour.

Link copied to clipboard
fun inWholeMetersPerSecond(): Long

Expresses the speed's value in meters per second.

Link copied to clipboard
fun inWholeMilesPerHour(): Long

Expresses the speed's value in miles per hour.

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

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

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

Link copied to clipboard
open override fun selfFactory(rawValue: Long): Speed

Creates a new instance with the provided rawValue.

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

Link copied to clipboard
open override fun toString(): String

Returns a formatted value.

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

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

Inherited functions

Link copied to clipboard
open fun abs(): Speed

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

Link copied to clipboard
open operator override fun compareTo(other: Speed): Int

Compares this object with the other object.

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

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

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

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

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

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