cfdm.core.Data.get_units

Data.get_units(default=ValueError())[source]

Return the units.

See also

del_units, has_units, set_units, get_calendar

Parameters
default: optional

Return the value of the default parameter if the units has not been set.

If set to an Exception instance then it will be raised instead.

Returns
str

The units.

Examples

>>> d.set_units('metres')
>>> d.has_units()
True
>>> d.get_units()
'metres'
>>> d.del_units()
>>> d.has_units()
False
>>> d.get_units()
ValueError: Can't get non-existent units
>>> print(d.get_units(None))
None
>>> print(d.del_units(None))
None