quantity/com.tomtom.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.

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

Types

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

The unit of a force's value.

Functions

Link copied to clipboard
open override fun abs(): Force

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

Link copied to clipboard
open operator override fun compareTo(other: Force): Int
Link copied to clipboard
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.

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

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

Link copied to clipboard
fun inKilowattHoursPer100km(): Double

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

Link copied to clipboard
fun inKilowattHoursPerKm(): Double

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

Link copied to clipboard
fun inNewtons(): Double

Expresses the force's value in newtons.

Link copied to clipboard
fun inWattHoursPer100km(): Double

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

Link copied to clipboard
fun inWholeKilowattHoursPer100km(): Long

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

Link copied to clipboard
fun inWholeKilowattHoursPerKm(): Long

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

Link copied to clipboard
fun inWholeNewtons(): Long

Expresses the force's value in newtons.

Link copied to clipboard
fun inWholeWattHoursPer100km(): Long

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

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

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

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

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

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

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

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

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

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

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