cfdm.core.ParametersDomainAncillaries.clear_domain_ancillaries

ParametersDomainAncillaries.clear_domain_ancillaries()[source]

Remove all domain_ancillaries.

New in version (cfdm): 1.7.0

Returns
dict

The domain ancillaries that have been removed.

Examples:

>>> f = cfdm.core.ParametersDomainAncillaries()
>>> f.domain_ancillaries()
{}
>>> d = {'a': 'domainancillary0',
...      'b': 'domainancillary1',
...      'orog': 'domainancillary2'}
>>> f.set_domain_ancillaries(d)
>>> f.domain_ancillaries()
{'a': 'domainancillary0',
 'b': 'domainancillary1',
 'orog': 'domainancillary2'}
>>> old = f.clear_domain_ancillaries()
>>> f.domain_ancillaries()
{}
>>> old
{'a': 'domainancillary0',
 'b': 'domainancillary1',
 'orog': 'domainancillary2'}