com.tomtom.quantity:quantity/com.tomtom.quantity/Quantity

Quantity

interface 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.

Parameters

The quantity type implementing this interface.

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

Inheritors

Types

Companion

object Companion

FormattedQuantity

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

Output structure of format.

Properties

rawValue

abstract val rawValue: Long

Raw unformatted value.

Functions

abs

open fun abs(): Q

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

compareTo

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

Compares this object with the other object.

div

open operator fun div(divisor: Q): Double

open operator fun div(divisor: Double): Q

open operator fun div(divisor: Int): Q

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

format

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

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

minus

open operator fun minus(other: Q): Q

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

plus

open operator fun plus(other: Q): Q

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

selfFactory

abstract fun selfFactory(rawValue: Long): Q

Creates a new instance with the provided rawValue.

times

open operator fun times(factor: Double): Q

open operator fun times(factor: Int): Q

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

toDouble

open fun toDouble(unit: U): Double

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

toLong

open fun toLong(unit: U): Long

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

unaryMinus

open operator fun unaryMinus(): Q

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