PyFoam.Basics.GeneralPlotTimelines module¶
Plots a collection of timelines. General superclass for te other implementations
-
class
PyFoam.Basics.GeneralPlotTimelines.
GeneralPlotTimelines
(timelines, custom, showWindow=True, registry=None)[source]¶ Bases:
object
This class defines the interface for specific implementations of plotting
This class is moedelled after the Gnuplot-class from the Gnuplot-package
-
__dict__
= mappingproxy({'__module__': 'PyFoam.Basics.GeneralPlotTimelines', '__doc__': 'This class defines the interface for specific implementations of plotting\n\n This class is moedelled after the Gnuplot-class from the Gnuplot-package', '__init__': <function GeneralPlotTimelines.__init__>, 'get_label_tag': <function GeneralPlotTimelines.get_label_tag>, 'testAlternate': <function GeneralPlotTimelines.testAlternate>, 'getNames': <function GeneralPlotTimelines.getNames>, 'hasTimes': <function GeneralPlotTimelines.hasTimes>, 'hasData': <function GeneralPlotTimelines.hasData>, 'redo': <function GeneralPlotTimelines.redo>, 'buildData': <function GeneralPlotTimelines.buildData>, 'preparePlot': <function GeneralPlotTimelines.preparePlot>, 'doReplot': <function GeneralPlotTimelines.doReplot>, 'addVerticalMarker': <function GeneralPlotTimelines.addVerticalMarker>, 'actualSetTitle': <function GeneralPlotTimelines.actualSetTitle>, 'setTitle': <function GeneralPlotTimelines.setTitle>, 'setYLabel': <function GeneralPlotTimelines.setYLabel>, 'setYLabel2': <function GeneralPlotTimelines.setYLabel2>, 'doHardcopy': <function GeneralPlotTimelines.doHardcopy>, '__dict__': <attribute '__dict__' of 'GeneralPlotTimelines' objects>, '__weakref__': <attribute '__weakref__' of 'GeneralPlotTimelines' objects>})¶
-
__init__
(timelines, custom, showWindow=True, registry=None)[source]¶ - Parameters
timelines (TimeLineCollection) – The timelines object
custom – A CustomplotInfo-object. Values in this object usually override the
other options :param showWindow: whether or not to show a window. Doesn’t affect all implementations
-
__module__
= 'PyFoam.Basics.GeneralPlotTimelines'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
addVerticalMarker
(colorRGB=None, label=None)[source]¶ Add a vertical line to the graph at the current time. Optionally color it and add a label
-
buildData
(times, name, title, lastValid, tag=None)[source]¶ Build the implementation specific data :param times: The vector of times for which data exists :param name: the name under which the data is stored in the timeline :param title: the title under which this will be displayed :param lastValid: wether the last data entry is valid
-
-
class
PyFoam.Basics.GeneralPlotTimelines.
PlotLinesRegistry
[source]¶ Bases:
object
Collects references to GeneralPlotLines objects
-
__dict__
= mappingproxy({'__module__': 'PyFoam.Basics.GeneralPlotTimelines', '__doc__': 'Collects references to GeneralPlotLines objects', 'nr': 1, '__init__': <function PlotLinesRegistry.__init__>, 'clear': <function PlotLinesRegistry.clear>, 'add': <function PlotLinesRegistry.add>, 'prepareForTransfer': <function PlotLinesRegistry.prepareForTransfer>, '__dict__': <attribute '__dict__' of 'PlotLinesRegistry' objects>, '__weakref__': <attribute '__weakref__' of 'PlotLinesRegistry' objects>})¶
-
__module__
= 'PyFoam.Basics.GeneralPlotTimelines'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
nr
= 1¶
-