cfdm.core.CoordinateConversion.set_domain_ancillary

CoordinateConversion.set_domain_ancillary(term, value, copy=True)[source]

Set an domain ancillary-valued term.

New in version (cfdm): 1.7.0

See also

del_domain_ancillary, domain_ancillaries, get_domain_ancillary

Parameters
term: str

The name of the term to be set.

value:

The value for the term.

copy: bool, optional

If True then set a deep copy of value.

Returns

None

Examples

>>> c = cfdm.core.CoordinateConversion()
>>> 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