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

Quantity

interface Quantity<Q : Quantity<Q, U>, U : Enum<*>> : Comparable<Q> , Serializable

A base interface for quantities. Outlines the common operations to retrieve values and perform mathematical operations.

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

Parameters

Q

The quantity type implementing this interface.

U

An enum type that contains the units that the quantity's values can be in.

Types

enum DecimalsMode : Enum<Quantity.DecimalsMode>

The options for how decimals should be treated in a string representation of a quantity.

enum SuffixMode : Enum<Quantity.SuffixMode>

The options for how a unit should be suffixed in a string representation of a quantity.

Functions

abstract fun abs(): Q

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

abstract operator fun compareTo(other: Q): Int

abstract operator fun div(divisor: Double): Q

abstract operator fun div(divisor: Int): Q

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

abstract operator fun minus(other: Q): Q

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

abstract operator fun plus(other: Q): Q

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

abstract operator fun times(factor: Double): Q

abstract operator fun times(factor: Int): Q

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

abstract fun toDouble(unit: U): Double

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

abstract fun toLong(unit: U): Long

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

abstract fun toString(unit: U, decimals: Int = 0, suffixMode: Quantity.SuffixMode = SuffixMode.NOT_SEPARATED, decimalsMode: Quantity.DecimalsMode = DecimalsMode.EXACT): 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.

abstract operator fun unaryMinus(): Q

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

Inheritors

ElectricCurrent

FuelConsumption