cf.Field.flag_meanings

Field.flag_meanings

The flag_meanings CF property.

Use in conjunction with flag_values to provide descriptive words or phrases for each flag value. If multi-word phrases are used to describe the flag values, then the words within a phrase should be connected with underscores. See http://cfconventions.org/latest.html for details.

Stored as a 1-d numpy string array but may be set as a space delimited string or any array-like object.

Examples

>>> f.flag_meanings = 'low medium      high'
>>> f.flag_meanings
array(['low', 'medium', 'high'],
      dtype='|S6')
>>> del flag_meanings

>>> f.flag_meanings = ['left', 'right']
>>> f.flag_meanings
array(['left', 'right'],
      dtype='|S5')

>>> f.flag_meanings = 'ok'
>>> f.flag_meanings
array(['ok'],
      dtype='|S2')

>>> f.set_property('flag_meanings', numpy.array(['a', 'b']))
>>> f.get_property('flag_meanings')
array(['a', 'b'],
      dtype='|S1')
>>> f.del_property('flag_meanings')