cfdm.DomainTopology.nc_get_connectivity_dimension

DomainTopology.nc_get_connectivity_dimension(default=ValueError())[source]

Return the netCDF connectivity dimension name.

Added in version (cfdm): 1.13.1.0

See also

nc_del_connectivity_dimension, nc_has_connectivity_dimension, nc_set_connectivity_dimension

Parameters:
default: optional

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

Returns:
str

The netCDF connectivity dimension name.

Examples

>>> f.nc_set_connectivity_dimension('time')
>>> f.nc_has_connectivity_dimension()
True
>>> f.nc_get_connectivity_dimension()
'time'
>>> f.nc_del_connectivity_dimension()
'time'
>>> f.nc_has_connectivity_dimension()
False
>>> print(f.nc_get_connectivity_dimension(None))
None
>>> print(f.nc_del_connectivity_dimension(None))
None