Package PyFoam :: Package LogAnalysis :: Module GeneralLineAnalyzer :: Class GeneralLineAnalyzer
[show private | hide private]
[frames | no frames]

Class GeneralLineAnalyzer

LogLineAnalyzer --+
                  |
                 GeneralLineAnalyzer

Known Subclasses:
FileLineAnalyzer, GeneralBoundingLineAnalyzer, GeneralContinuityLineAnalyzer, GeneralDeltaTLineAnalyzer, GeneralExecutionLineAnalyzer, GeneralLinearSolverLineAnalyzer, GeneralSimpleLineAnalyzer, RegExpLineAnalyzer, TimeLineLineAnalyzer

Base class for analyzers that write data to files and store time-lines

Combines the capabilities of TimeLineLineAnalyzer and FileLineAnalyzer
Method Summary
  __init__(self, doTimelines, doFiles, titles)
  addToFiles(self, match)
Method that adds matched data to files
  addToTimelines(self, match)
Method that adds matched data to timelines
  doAnalysis(self, line)
General analysis method.
  endAnalysis(self, match)
Method at the end of a successfull match
  getTimeline(self, name)
Return the timeline as two list: the times and the values
  setDirectory(self, oDir)
Creates the OutFileCollection-object
  setTitles(self, titles)
Sets the titles anew
  startAnalysis(self, match)
Method at the start of a successfull match
  timeChanged(self)
Sets the current time in the timelines
    Inherited from LogLineAnalyzer
  getTime(self)
Return current time
  goOn(self)
If the analyzer thinks the simulation should be stopped (for instance because of convergence) it returns false
  setParent(self, parent)
Introduces the LineAnalyzer to its supervisor

Method Details

__init__(self, doTimelines=False, doFiles=False, titles=[])
(Constructor)

Parameters:
titles - The titles of the data elements
Overrides:
PyFoam.LogAnalysis.LogLineAnalyzer.LogLineAnalyzer.__init__

addToFiles(self, match)

Method that adds matched data to files
Parameters:
match - data matched by a regular expression

addToTimelines(self, match)

Method that adds matched data to timelines
Parameters:
match - data matched by a regular expression

doAnalysis(self, line)

General analysis method. Derived classes should instead override callbacks
Overrides:
PyFoam.LogAnalysis.LogLineAnalyzer.LogLineAnalyzer.doAnalysis

endAnalysis(self, match)

Method at the end of a successfull match

getTimeline(self, name)

Parameters:
name - Name of the timeline to return
Returns:
the timeline as two list: the times and the values

setDirectory(self, oDir)

Creates the OutFileCollection-object
Overrides:
PyFoam.LogAnalysis.LogLineAnalyzer.LogLineAnalyzer.setDirectory

setTitles(self, titles)

Sets the titles anew
Parameters:
titles - the new titles

startAnalysis(self, match)

Method at the start of a successfull match

timeChanged(self)

Sets the current time in the timelines
Overrides:
PyFoam.LogAnalysis.LogLineAnalyzer.LogLineAnalyzer.timeChanged

Generated by Epydoc 2.1 on Mon Jan 22 23:52:48 2007 http://epydoc.sf.net