cfdm.Domain.nc_get_mesh_variable

Domain.nc_get_mesh_variable(default=ValueError())[source]

Return the netCDF mesh variable name.

Added in version (cfdm): 1.13.1.0

See also

nc_del_mesh_variable, nc_has_mesh_variable, nc_set_mesh_variable

Parameters:
default: optional

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

Returns:
str

The netCDF mesh variable name. If unset then default is returned, if provided.

Examples

>>> f.nc_set_mesh_variable('mesh1')
>>> f.nc_has_mesh_variable()
True
>>> f.nc_get_mesh_variable()
'mesh1'
>>> f.nc_del_mesh_variable()
'mesh1'
>>> f.nc_has_mesh_variable()
False
>>> print(f.nc_get_mesh_variable(None))
None
>>> print(f.nc_del_mesh_variable(None))
None