mapsglmaps/com.xweather.mapsgl.extensions

Package-level declarations

Types

abstract class Dimension(val symbol: String, val converter: UnitConverter)

A Dimension is a base class for a specific type of unit, like length or temperature.

data class Measurement<out UnitType : Dimension>(val value: Double, val unit: UnitType) : Comparable<Measurement<UnitType>>

A Measurement holds a value in a specific unit.

UnitConcentrationMass

sealed class UnitConcentrationMass : Dimension

UnitConverter

abstract class UnitConverter

A UnitConverter provides the mechanism to convert between different units of the same dimension.

UnitConverterLinear

class UnitConverterLinear(val coefficient: Double, val constant: Double = 0.0) : UnitConverter

A linear converter that applies a coefficient (and optionally a constant) for conversion. Formula: y = m * x + b

UnitDuration

sealed class UnitDuration : Dimension

UnitHeight

sealed class UnitHeight : Dimension

UnitHeightDifference

sealed class UnitHeightDifference : Dimension

UnitLength

sealed class UnitLength : Dimension

UnitNone

sealed class UnitNone : Dimension

UnitProportion

sealed class UnitProportion : Dimension

UnitRadarReflectivity

sealed class UnitRadarReflectivity : Dimension

UnitSpeed

sealed class UnitSpeed : Dimension

UnitTemperature

sealed class UnitTemperature : Dimension

UnitTemperatureDelta

sealed class UnitTemperatureDelta : Dimension

Functions

celsius

fun Measurement.Companion.celsius(value: Double): Measurement<UnitTemperature.Celsius>

celsiusRange

fun celsiusRange(range: ClosedRange<Double>): ClosedRange<Measurement<UnitTemperature.Celsius>>

Creates a ClosedRange of Temperature Measurements in Celsius from a Double range.

centimeters

fun Measurement.Companion.centimeters(value: Double): Measurement<UnitLength.Centimeters>

convert

fun <T : Dimension> Double.convert(from: T, to: T): Double

Converts a Double from one unit to another of the same dimension.

dbz

fun Measurement.Companion.dbz(value: Double): Measurement<UnitRadarReflectivity.DecibelRelativeToZ>

decimalProportion

fun Measurement.Companion.decimalProportion(value: Double): Measurement<UnitProportion.DecimalProportion>

decimalProportionRange

fun decimalProportionRange(range: ClosedRange<Double>): ClosedRange<Measurement<UnitProportion.DecimalProportion>>

Creates a ClosedRange of Proportion Measurements from a Double range representing a decimal proportion (e.g., 0.0 to 1.0).

fahrenheit

fun Measurement.Companion.fahrenheit(value: Double): Measurement<UnitTemperature.Fahrenheit>

fahrenheitRange

fun fahrenheitRange(range: ClosedRange<Double>): ClosedRange<Measurement<UnitTemperature.Fahrenheit>>

Creates a ClosedRange of Temperature Measurements in Fahrenheit from a Double range.

fromDBZ

fun Measurement.Companion.fromDBZ(dbzValue: Double): Measurement<UnitSpeed>

Marshall-Palmer formula for conversion of dBZ to rainfall rate in mm/h.

inches

fun Measurement.Companion.inches(value: Double): Measurement<UnitLength.Inches>

knots

fun Measurement.Companion.knots(value: Double): Measurement<UnitSpeed.Knots>

metersPerSecond

fun Measurement.Companion.metersPerSecond(value: Double): Measurement<UnitSpeed.MetersPerSecond>

microgramsPerCubicMeter

fun Measurement.Companion.microgramsPerCubicMeter(value: Double): Measurement<UnitConcentrationMass.MicrogramsPerCubicMeter>

milesPerHour

fun Measurement.Companion.milesPerHour(value: Double): Measurement<UnitSpeed.MilesPerHour>

percent

fun Measurement.Companion.percent(value: Double): Measurement<UnitProportion.Percent>

percentRange

fun percentRange(range: ClosedRange<Double>): ClosedRange<Measurement<UnitProportion.Percent>>

Creates a ClosedRange of Proportion Measurements from a Double range representing percentages (e.g., 0.0 to 100.0).

replacingValues

fun <UnitType : Dimension> ClosedRange<Measurement<UnitType>>.replacingValues(values: ClosedRange<Double>): ClosedRange<Measurement<UnitType>>

Creates a new ClosedRange<Measurement<UnitType>> from a numeric range using the same unit type as this range.

toUnitSpeed

fun Measurement<UnitRadarReflectivity>.toUnitSpeed(targetUnit: UnitSpeed): Measurement<UnitSpeed>

values

fun <UnitType : Dimension> ClosedRange<Measurement<UnitType>>.values(): ClosedRange<Double>

Returns a ClosedRange<Double> with just the numeric values from a range of Measurements.

fun <UnitType : Dimension> ClosedRange<Measurement<UnitType>>.values(convertedTo: UnitType): ClosedRange<Double>

Returns numeric bounds converted to the specified unit first.