cf.CellMethods.dump

CellMethods.dump(id=None)[source]

Return a string containing a full description of the instance.

If a cell methods ‘name’ is followed by a ‘*’ then that cell method is relevant to the data in a way which may not be precisely defined its corresponding dimension or dimensions.

Parameters :
id : str, optional

Set the common prefix of component names. By default the instance’s class name is used.

Returns :
out : str

A string containing the description.

Examples

>>> x = c.dump()
>>> print c.dump()
>>> print c.dump(id='cellmethods1')

Previous topic

cf.CellMethods.copy

Next topic

cf.CellMethods.equals

This Page