HeartRate
A heart rate (LOINC 8867-4), a Frequency from 0 to 300 beats a minute, written 72bpm and shown 72 bpm. Health data.
Health; ordered; since Jadpo 0.1.0.
Make one
It is a Frequency with bounds of its own: build one as you build a Frequency, and a value outside its bounds breaks min or max.
text.parse(raw, as: HeartRate) reads one from its text; text that isn't one at all fails malformed, such as 72, bpm or "".
These operations give one: units.of and units.sum.
Text, JSON and storage
text.from writes its canonical text, the one form text.parse reads back. JSON sends an object of its parts.
| Text | JSON |
|---|---|
1 Hz |
{"value":"1","unit":"Hz"} |
1.2 Hz |
{"value":"1.2","unit":"Hz"} |
1.217 Hz |
{"value":"1.217","unit":"Hz"} |
2.5 Hz |
{"value":"2.5","unit":"Hz"} |
It is stored in one column named for the field, of type numeric(38, 3), holding the frequency in hertz (Hz). 1.217 Hz is stored as 1.217.
Shown to people
text.format(value, locale:) shows it to people in their locale. A call may also give unit:.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
1 Hz |
60 bpm |
1.2 Hz |
72 bpm |
1.217 Hz |
73 bpm |
2.5 Hz |
150 bpm |
Operations
units.in(value: Quantity, unit: QuantityUnit, scale: Int, rounding: Rounding) -> Decimal:valueinunit, a unit of its kind, as aDecimalofscaleplaces rounded byrounding:units.in(5km, LengthUnit.mile, scale: 2, rounding: Rounding.half_even)is3.11.units.of(value: Number, unit: QuantityUnit) -> Quantity:valueofunit, anIntor aDecimal, as the quantity ofunit's kind, converted exactly to the base unit and rounded half to even to the kind's scale:units.of(5, LengthUnit.mile).units.sum(items: List<Quantity>) -> Quantity: The items added up, all of one kind; nothing for no items. ATemperatureor aSoundLeveldoesn't add to itself, so neither is summed.
Like every standard type, it also has the contract's own operations: text.parse, text.from, text.format, json.read, json.write and ==. It is ordered, so < and sorting take it. Every standard type meets one contract says how they work.
Markdown for agents: /docs/types/type-heart-rate.md.Built from Jadpo main at e00e61f.