PyFoam.Basics.CustomPlotInfo module

Information about custom plots

class PyFoam.Basics.CustomPlotInfo.CustomPlotInfo(raw=None, name=None, enabled=True)

Bases: object

Information about a custom plot

__dict__ = mappingproxy({'__weakref__': <attribute '__weakref__' of 'CustomPlotInfo' objects>, '__init__': <function CustomPlotInfo.__init__>, '__doc__': 'Information about a custom plot', '__str__': <function CustomPlotInfo.__str__>, '__module__': 'PyFoam.Basics.CustomPlotInfo', 'set': <function CustomPlotInfo.set>, '__dict__': <attribute '__dict__' of 'CustomPlotInfo' objects>, 'nr': 1, 'getDict': <function CustomPlotInfo.getDict>})

__init__(raw=None, name=None, enabled=True)

Parameters:raw – The raw data. Either a string for the two legacy-formats or a

dictionary for the new format :param name: Name of the expression (only to be used for the new format) :param enabled: Should this plot be actually used?

__module__ = 'PyFoam.Basics.CustomPlotInfo'

__str__()

__weakref__

list of weak references to the object (if defined)

getDict(wrapStrings=False)

nr = 1

set(key, value)

PyFoam.Basics.CustomPlotInfo.cleanString(data)

PyFoam.Basics.CustomPlotInfo.encloseString(data)

PyFoam.Basics.CustomPlotInfo.readCustomPlotInfo(rawData, useName=None)

Determines which of the three possible formats for custom-plotting is used and returns a list of CustomPlotInfo-objects :param rawData: a string that contains the raw data

PyFoam.Basics.CustomPlotInfo.resetCustomCounter()

Reset the counter. Use with care