cfdm.Index.nc_get_dimension

Index.nc_get_dimension(default=ValueError())[source]

Return the netCDF dimension name.

New in version (cfdm): 1.7.0

See also

nc_del_dimension, nc_has_dimension, nc_set_dimension

Parameters
default: optional

Return the value of the default parameter if the netCDF dimension name has not been set. If set to an Exception instance then it will be raised instead.

Returns
str

The netCDF dimension name.

Examples

>>> f.nc_set_dimension('time')
>>> f.nc_has_dimension()
True
>>> f.nc_get_dimension()
'time'
>>> f.nc_del_dimension()
'time'
>>> f.nc_has_dimension()
False
>>> print(f.nc_get_dimension(None))
None
>>> print(f.nc_del_dimension(None))
None