cfdm.DimensionCoordinate.get_climatology

DimensionCoordinate.get_climatology(default=ValueError())[source]

Return the climatology setting.

New in version (cfdm): 1.8.9.0

See also

del_climatology, is_climatology, set_climatology,

Parameters
default: optional

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

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

Returns

str

Examples

>>> c = cfdm.DimensionCoordinate()
>>> c.set_climatology(True)
>>> c.is_climatology()
True
>>>  c.get_climatology()
True
>>> c.del_climatology()
True
>>> c.is_climatology()
False
>>> print(c.get_climatology(None))
None
>>> print(c.del_climatology(None))
None
>>> c.set_climatology(False)
>>> c.is_climatology()
False