cf.Comparison.dump

Comparison.dump(id=None)[source]

Return a string containing a full description of the instance.

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='comparison1')

Previous topic

cf.Comparison.copy

Next topic

cf.Comparison.evaluate

This Page