cfdm.Index.set_data

Index.set_data(data, copy=True, inplace=True)[source]

Set the data.

The units, calendar and fill value of the incoming Data instance are removed prior to insertion.

New in version (cfdm): 1.7.0

See also

data, del_data, get_data, has_data

Parameters
data: data_like

The data to be inserted.

A data_like object is any object that can be converted to a Data object, i.e. numpy array_like objects, Data objects, and cfdm instances that contain Data objects.

copy: bool, optional

If True (the default) then copy the data prior to insertion, else the data is not copied.

inplace: bool, optional:

If True (the default) then do the operation in-place and return None. If False a new, modified Index instance is returned.

New in version (cfdm): 1.8.7.0

Returns
None or Index

If the operation was in-place then None is returned, otherwise return a new Index instance containing the new data.

Examples

>>> f = cfdm.Index()
>>> f.set_data([1, 2, 3])
>>> f.has_data()
True
>>> f.get_data()
<Data(3): [1, 2, 3]>
>>> f.data
<Data(3): [1, 2, 3]>
>>> f.del_data()
<Data(3): [1, 2, 3]>
>>> g = f.set_data([4, 5, 6], inplace=False)
>>> g.data
<Data(3): [4, 5, 6]>
>>> f.has_data()
False
>>> print(f.get_data(None))
None
>>> print(f.del_data(None))
None