cfdm.core.ParametersDomainAncillaries.del_domain_ancillary

ParametersDomainAncillaries.del_domain_ancillary(domain_ancillary, default=ValueError())[source]

Delete a domain ancillary.

New in version (cfdm): 1.7.0

See also

domain_ancillaries, get_domain_ancillary, set_domain_ancillary

Parameters
domain_ancillary: str

The name of the domain ancillary to be deleted.

Parameter example:

domain_ancillary='orog'

default: optional

Return the value of the default parameter if the domain ancillary term has not been set.

If set to an Exception instance then it will be raised instead.

Returns
str

The removed domain ancillary key.

Examples

>>> c = cfdm.core.ParametersDomainAncillaries()
>>> c.set_domain_ancillary('orog', 'domainancillary2')
>>> c.has_domain_ancillary('orog')
True
>>> c.get_domain_ancillary('orog')
'domainancillary2'
>>> c.del_domain_ancillary('orog')
'domainancillary2'
>>> c.has_domain_ancillary('orog')
False
>>> print(c.del_domain_ancillary('orog', None))
None
>>> print(c.get_domain_ancillary('orog', None))
None