cfdm.CoordinateConversion.get_domain_ancillary

CoordinateConversion.get_domain_ancillary(domain_ancillary, default=ValueError())[source]

Return a domain ancillary term.

New in version (cfdm): 1.7.0

See also

del_domain_ancillary, domain_ancillaries, set_domain_ancillary

Parameters
domain_ancillary: str

The name of the term.

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

The domain ancillary construct key.

Examples

>>> c = cfdm.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