cfdm.core.CellMeasure.get_measure

CellMeasure.get_measure(default=ValueError())[source]

Return the measure.

New in version (cfdm): 1.7.0

See also

del_measure, has_measure, set_measure

Parameters
default: optional

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

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

Returns

The value of the measure.

Examples

>>> c = cfdm.core.CellMeasure()
>>> c.set_measure('area')
>>> c.has_measure()
True
>>> c.get_measure()
'area'
>>> c.del_measure()
'area'
>>> c.has_measure()
False
>>> print(c.del_measure(None))
None
>>> print(c.get_measure(None))
None