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

actualSetTitle(title)[source]

Sets the title

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

doHardcopy(filename, form, termOpts=None)[source]

Write the contents of the plot to disk :param filename: Name of the file without type extension :param form: String describing the format

doReplot()[source]

Replot the whole data

getNames()[source]

Get the names of the data items

get_label_tag(name)[source]
hasData()[source]

Check whether there is any plotable data

hasTimes()[source]

Check whether this timeline contains any timesteps

preparePlot()[source]

Prepare the plotting window

redo()[source]

Replot the timelines

setTitle(title)[source]

Sets the title

setYLabel(title)[source]

Sets the label on the first Y-Axis

setYLabel2(title)[source]

Sets the label on the second Y-Axis

testAlternate(name)[source]
class PyFoam.Basics.GeneralPlotTimelines.PlotLinesRegistry[source]

Bases: object

Collects references to GeneralPlotLines objects

add(plot)[source]
clear()[source]
nr = 1
prepareForTransfer()[source]

Makes sure that the data about the plots is to be transfered via XMLRPC

PyFoam.Basics.GeneralPlotTimelines.allPlots()[source]