HeartRate, a standard type

A heart rate: 72bpm.

Use it for a person's pulse, from 0 to 300 beats a minute. For any other rate, use Frequency.

Shape

One Frequency, with limits of its own.

Example

example

HeartRate(72bpm)

A value outside its limits breaks min or max.

text.parse(raw, as: HeartRate) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as 72, bpm or seventy-two.

These operations give one: units.of and units.sum.

Good to know

It is a Frequency, so in JSON and storage it is in hertz: 72 bpm is 1.2 Hz.
== tells you whether two are the same, and < and list.sort_by compare and sort them.
A field that holds one counts as personal data (health), so you don't mark it yourself.

In JSON

An object of its parts, in a request, a response or json.write:

json

{"value":"1","unit":"Hz"}{"value":"1.2","unit":"Hz"}{"value":"1.217","unit":"Hz"}

Details

Text form, storage, how it is shown, and operations

HeartRate is in the group Health, and has been in Jadpo since 0.1.0.

Text form

text.from writes one standard text form, the same form text.parse reads back: 1 Hz, 1.2 Hz and 1.217 Hz.

How it is stored

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.

How it is 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: value in unit, a unit of its kind, as a Decimal of scale places rounded by rounding: units.in(5km, LengthUnit.mile, scale: 2, rounding: Rounding.half_even) is 3.11.
units.of(value: Number, unit: QuantityUnit) -> Quantity: value of unit, an Int or a Decimal, as the quantity of unit'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. A Temperature or a SoundLevel doesn't add to itself, so neither is summed.

It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.