AreaUnit

Defines an area unit of measurement. The area unit class is derived from the unit class.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(unitId: AreaUnitId)

Creates a unit given its known id.

constructor(linearUnit: LinearUnit)

Creates an area unit given a linear unit. Creates a unit given a linear unit.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The AreaUnitId of the given Area unit. If an error occurs then AreaUnitId.Other is returned.

Inherited properties

Link copied to clipboard

The abbreviation of the unit. The abbreviation for a specific unit.

Link copied to clipboard

The display name of the unit. The display name for a specific unit.

Link copied to clipboard

The name of the unit. The name for a specific unit.

Link copied to clipboard

The display name of the unit. The display name for a specific unit.

Link copied to clipboard
val wkid: Int

The well-known ID for the unit, or 0 for a custom unit.

Functions

Link copied to clipboard
fun convertFrom(fromUnit: AreaUnit, area: Double): Double

Converts a value in another UOM into this UOM.

Link copied to clipboard
fun convertTo(toUnit: AreaUnit, area: Double): Double

Converts a value in this UOM into another UOM.

Link copied to clipboard

Converts a square meter value to this UOM.

Link copied to clipboard

Converts a value in this UOM to square meters.

Inherited functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int