api_quantity/com.tomtom.tools.android.api.quantity/Temperature

Temperature

@Serializable

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

A quantity describing temperature. (For example, 21 degrees Celsius.)

Types

object Companion

enum Unit : Enum<Temperature.Unit> , CommonShareableBase

The unit of temperature's value.

Properties

val rawValue: Long

Functions

open override fun abs(): Temperature

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

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

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

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

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

fun inCelsius(): Double

Expresses the temperature's value in degrees Celsius.

fun inFahrenheit(): Double

Expresses the temperature's value in degrees Fahrenheit.

fun inWholeCelsius(): Long

Expresses the temperature's value in degrees Celsius rounded.

inWholeFahrenheit

fun inWholeFahrenheit(): Long

Expresses the temperature's value in degrees Fahrenheit rounded.

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

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

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

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

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

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

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

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

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

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

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

open override fun toString(): String

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

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