Class

Dimension

An abstract class representing a dimensional unit of measure.

Overview

The Foundation framework provides concrete subclasses for many of the most common types of physical units.

NSDimension subclass

Description

Base unit

UnitAcceleration

Unit of measure for acceleration

meters per second squared (m/s²)

UnitAngle

Unit of measure for planar angle and rotation

degrees (°)

UnitArea

Unit of measure for area

square meters (m²)

UnitConcentrationMass

Unit of measure for concentration of mass

milligrams per deciliter (mg/dL)

UnitDispersion

Unit of measure for dispersion

parts per million (ppm)

UnitDuration

Unit of measure for duration

seconds (sec)

UnitElectricCharge

Unit of measure for electric charge

coulombs (C)

UnitElectricCurrent

Unit of measure for electric current

amperes (A)

UnitElectricPotentialDifference

Unit of measure for electric potential difference

volts (V)

UnitElectricResistance

Unit of measure for electric resistance

ohms (Ω)

UnitEnergy

Unit of measure for energy

joules (J)

UnitFrequency

Unit of measure for frequency

hertz (Hz)

UnitFuelEfficiency

Unit of measure for fuel consumption

liters per 100 kilometers (L/100km)

UnitIlluminance

Unit of measure for illuminance

lux (lx)

UnitLength

Unit of measure for length

meters (m)

UnitMass

Unit of measure for mass

kilograms (kg)

UnitPower

Unit of measure for power

watts (W)

UnitPressure

Unit of measure for pressure

newtons per square meter (N/m²)

UnitSpeed

Unit of measure for speed

meters per second (m/s)

UnitTemperature

Unit of measure for temperature

kelvin (K)

UnitVolume

Unit of measure for volume

liters (L)

Each instance of an Dimension subclass has a converter, which is used to represent the unit in terms of the dimension’s baseUnit(). For example, the NSLengthUnit class uses meters as its base unit. The predefined miles unit is defined by a UnitConverterLinear with a coefficient of 1609.34, which corresponds to the conversion ratio of miles to meters (1 mi = 1609.34 m); the predefined meters unit is defined by a UnitConverterLinear with a coefficient of 1.0, because it’s the base unit.

You typically use an NSDimension subclass in conjunction with the NSMeasurement class to represent specific quantities of a particular unit.

Working with Custom Units

In addition to the Apple-provided units, you can define custom units. Custom units can be initialized from a symbol and converter of an existing type or implemented as a class method of an existing type for additional convenience. You can also define your own NSDimension subclass to represent an entirely new unit dimension.

Initializing a Custom Unit with a Specified Symbol and Definition

The simplest way to define a custom unit is to create a new instance of an existing NSDimension subclass using the init(symbol:converter:) method.

For example, the smoot is a nonstandard unit of length (1 smoot = 1.70180 m). You can create a new instance of UnitLength as follows:

let smoots = UnitLength(symbol: "smoot", converter: UnitConverterLinear(coefficient: 1.70180))

Extending Existing NSDimension Subclasses

Alternatively, if a custom unit is used extensively throughout an app, consider extending the corresponding NSDimension subclass and adding a class method.

For example, speed can be measured in furlongs per fortnight (1 fur/ftn = 201.168 m / 1,209,600 s). If an app makes frequent use of this unit, you can extend UnitSpeed to add a furlongsPerFortnight class method for convenient access as follows:

extension UnitSpeed {
    static let furlongPerFortnight = UnitSpeed(symbol: "fur/ftn", converter: UnitConverterLinear(coefficient: 201.168 / 1209600.0))
}

Creating a Custom NSDimension Subclass

You can create a new subclass of NSDimension to describe a new unit dimension.

For example, the Foundation framework does not define any units for radioactivity. Radioactivity is the process by which the nucleus of an atom emits radiation. The SI unit of measure for radioactivity is the becquerel (Bq), which is defined as the quantity of radioactive material in which one nucleus decays per second (1 Bq = 1 s-1). Radioactivity is also commonly described in terms of curies (Ci), a unit defined relative to the decay of one gram of the radium-226 isotope (1 Ci = 3.7 × 1010 Bq). You can implement a CustomUnitRadioactivity class that defines both units of radioactivity as follows:

class CustomRadioactivityUnit: Dimension {
    static let becquerel = CustomRadioactivityUnit(symbol: "Bq", UnitConverterLinear(coefficient: 1.0))
    static let curie = CustomRadioactivityUnit(symbol: "Ci", UnitConverterLinear(coefficient: 3.7e10))
    
    static let baseUnit = self.becquerel
}

Subclassing Notes

NSDimension is intended for subclassing. Although the subclasses listed in are suitable for most purposes, you may want to define a custom unit type. For instance, you may need a custom unit type to represent a derived unit, such as magnetic flux (measured as the product of electric potential difference and time).

To represent dimensionless units, subclass Unit directly.

Methods to Override

All subclasses must fully implement the baseUnit() method designating the base unit, relative to which any additional units are defined.

You should also implement a class method named for the base unit itself, which may be used interchangeably. For example, the UnitIlluminance class defines its baseUnit in terms of the lux (lx), and provides a corresponding lux class method.

Alternatives to Subclassing

As described in Working with Custom Units, you only need to create a custom subclass of NSDimension if a unit of the desired dimension is not yet defined. You can define a custom unit for an existing NSDimension subclass by either calling the init(symbol:converter:) method or extending the subclass and adding a corresponding class method.

Topics

Creating Dimensions

init(symbol: String, converter: UnitConverter)

Initializes a dimensional unit with the specified symbol and unit converter.

Accessing the Unit Converter

var converter: UnitConverter

Returns the unit converter used to represent the unit in terms of the dimension’s base unit.

Accessing the Base Unit

class func baseUnit()

Returns the base unit.

Relationships

Inherits From

Conforms To

See Also

First Steps

struct Measurement

A numeric quantity labeled with a unit of measure, with support for unit conversion and unit-aware calculations.

class Unit

An abstract class representing a unit of measure.