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

Force

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

A quantity describing force. (For example, 10 newtons.)

Force is commonly used for electric vehicle efficiency. In those use-cases, force tends to be measured in kilowatt-hours per 100 kilometer rather than newtons.

Types

Companion

object Companion

Unit

enum Unit : Enum<Force.Unit>

The unit of a force's value.

Functions

abs

open override fun abs(): Force

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

compareTo

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

div

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

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

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

inKilowattHoursPer100km

fun inKilowattHoursPer100km(): Double

Expresses the force's value in kilowatt-hours per 100 kilometers.

inNewtons

fun inNewtons(): Double

Expresses the force's value in newtons.

inWholeKilowattHoursPer100km

fun inWholeKilowattHoursPer100km(): Long

Expresses the force's value in kilowatt-hours per 100 kilometers rounded down.

inWholeNewtons

fun inWholeNewtons(): Long

Expresses the force's value in newtons rounded down.

minus

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

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

plus

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

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

times

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

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

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

toDouble

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

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

toLong

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

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

toString

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

unaryMinus

open operator override fun unaryMinus(): Force

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

Inherited functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)