cfdm.AuxiliaryCoordinate.nc_get_node_coordinate_variable

AuxiliaryCoordinate.nc_get_node_coordinate_variable(default=ValueError())[source]

Return the netCDF node coordinate variable name.

New in version (cfdm): 1.11.0.0

See also

nc_del_node_coordinate_variable, nc_has_node_coordinate_variable, nc_set_node_coordinate_variable

Parameters
default: optional

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

Returns
str

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

Examples

>>> f.nc_set_node_coordinate_variable('node_x')
>>> f.nc_has_node_coordinate_variable()
True
>>> f.nc_get_node_coordinate_variable()
'node_x'
>>> f.nc_del_node_coordinate_variable()
'node_x'
>>> f.nc_has_node_coordinate_variable()
False
>>> print(f.nc_get_node_coordinate_variable(None))
None
>>> print(f.nc_del_node_coordinate_variable(None))
None