Package PyFoam :: Package Basics :: Module GeneralPlotTimelines :: Class GeneralPlotTimelines
[hide private]
[frames] | no frames]

Class GeneralPlotTimelines

source code

object --+
         |
        GeneralPlotTimelines

This class defines the interface for specific implementations of plotting

This class is moedelled after the Gnuplot-class from the Gnuplot-package

Instance Methods [hide private]
 
__init__(self, timelines, custom, showWindow=True, registry=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
getNames(self)
Get the names of the data items
source code
 
hasTimes(self)
Check whether this timeline contains any timesteps
source code
 
hasData(self)
Check whether there is any plotable data
source code
 
redo(self)
Replot the timelines
source code
 
buildData(self, times, name, title, lastValid)
Build the implementation specific data
source code
 
preparePlot(self)
Prepare the plotting window
source code
 
doReplot(self)
Replot the whole data
source code
 
actualSetTitle(self, title)
Sets the title
source code
 
setTitle(self, title)
Sets the title
source code
 
setYLabel(self, title)
Sets the label on the first Y-Axis
source code
 
setYLabel2(self, title)
Sets the label on the second Y-Axis
source code
 
doHardcopy(self, filename, form)
Write the contents of the plot to disk
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, timelines, custom, showWindow=True, registry=None)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • timelines (TimeLineCollection) - The timelines object
  • custom - A CustomplotInfo-object. Values in this object usually override the other options
  • showWindow - whether or not to show a window. Doesn't affect all implementations
Overrides: object.__init__

buildData(self, times, name, title, lastValid)

source code 

Build the implementation specific data

Parameters:
  • times - The vector of times for which data exists
  • name - the name under which the data is stored in the timeline
  • title - the title under which this will be displayed
  • lastValid - wether the last data entry is valid

doHardcopy(self, filename, form)

source code 

Write the contents of the plot to disk

Parameters:
  • filename - Name of the file without type extension
  • form - String describing the format