quantity/com.tomtom.quantity/Quantity

Quantity

abstract class Quantity<Q : Quantity<Q, U>, U : UnitBase> : 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

The quantity type implementing this interface.

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

Constructors

Quantity

fun Quantity()

Types

FormattedQuantity

data class FormattedQuantity(val value: Double, val units: String)

Output structure of format.

Functions

abs

abstract fun abs(): Q

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

compareTo

abstract operator fun compareTo(other: Q): Int

div

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.

format

abstract fun format(unit: U): Quantity.FormattedQuantity

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

minus

abstract operator fun minus(other: Q): Q

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

plus

abstract operator fun plus(other: Q): Q

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

times

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.

toDouble

abstract fun toDouble(unit: U): Double

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

toLong

abstract fun toLong(unit: U): Long

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

unaryMinus

abstract operator fun unaryMinus(): Q

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

Inheritors