cfdm.Field.nc_get_geometry_variable

Field.nc_get_geometry_variable(default=ValueError())[source]

Return the netCDF geometry container variable name.

New in version (cfdm): 1.8.0

See also

nc_del_geometry_variable, nc_has_geometry_variable, nc_set_geometry_variable

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 geometry container variable name.

Examples

>>> f.nc_set_geometry_variable('geometry')
>>> f.nc_has_geometry_variable()
True
>>> f.nc_get_geometry_variable()
'geometry'
>>> f.nc_del_geometry_variable()
'geometry'
>>> f.nc_has_geometry_variable()
False
>>> print(f.nc_get_geometry_variable(None))
None
>>> print(f.nc_del_geometry_variable(None))
None