cfdm.Index.nc_set_sample_dimension

Index.nc_set_sample_dimension(value)[source]

Set the netCDF sample dimension 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.7.0

See also

nc_del_sample_dimension, nc_get_sample_dimension, nc_has_sample_dimension

Parameters
value: str

The value for the netCDF sample dimension name.

Returns

None

Examples

>>> f.nc_set_sample_dimension('time')
>>> f.nc_has_sample_dimension()
True
>>> f.nc_get_sample_dimension()
'time'
>>> f.nc_del_sample_dimension()
'time'
>>> f.nc_has_sample_dimension()
False
>>> print(f.nc_get_sample_dimension(None))
None
>>> print(f.nc_del_sample_dimension(None))
None