cfdm.Field.nc_set_geometry_variable

Field.nc_set_geometry_variable(value)[source]

Set the netCDF geometry container variable name.

If there are any / (slash) characters in the netCDF name then these act as delimiters for a group hierarchy. By default, or if the name starts with a / character and contains no others, the name is assumed to be in the root group.

New in version (cfdm): 1.8.0

See also

nc_del_geometry_variable, nc_get_geometry_variable, nc_has_geometry_variable

Parameters
value: str

The value for the netCDF geometry container variable name.

Returns

None

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