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

Parameters

Q

The quantity type implementing this interface.

U

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

Inheritors

Types

Link copied to clipboard
object Companion
Link copied to clipboard
data class FormattedQuantity(val value: Double, val symbol: String)

Output structure of format.

Functions

Link copied to clipboard
fun abs(): Q

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

Link copied to clipboard
operator override fun compareTo(other: Q): Int
Link copied to clipboard
operator fun div(divisor: Q): Double

operator fun div(divisor: Double): Q
operator fun div(divisor: Int): Q

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

Link copied to clipboard
fun format(unit: U): Quantity.FormattedQuantity

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

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
operator fun minus(other: Q): Q

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

Link copied to clipboard
operator fun plus(other: Q): Q

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

Link copied to clipboard
operator fun times(factor: Double): Q
operator fun times(factor: Int): Q

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

Link copied to clipboard
operator fun unaryMinus(): Q

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