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

Class UtilityAnalyzer

FoamLogAnalyzer --+
                  |
                 UtilityAnalyzer


Analyzer for non-solver Utilities

Regular expressions can be added and the data generated by them can be accessed
Method Summary
  __init__(self, progress)
  addExpression(self, name, expr, idNr)
Add a RegExp
  getData(self, name, time, ID)
Get data
  getIDs(self, name)
Get a list with the available IDs
  getTimes(self, name, ID)
Get a list with the available times for a specific ID
    Inherited from FoamLogAnalyzer
  addAnalyzer(self, name, obj)
Adds an analyzer
  addTimeListener(self, listener)
  analyze(self, fh)
Analyzes a file (one line at a time)
  analyzeLine(self, line)
Calls all the anlyzers for a line
  getAnalyzer(self, name)
Get the LogLineAnalyzer name
  getDirectory(self)
Gets the output directory
  getTime(self)
Gets the current time
  goOn(self)
Checks with all the analyzers
  setDirectory(self, d)
Sets the output directory for all the analyzers
  setTime(self, time)
Sets the time and alert all the LineAnalyzers that the time has changed
  tearDown(self)
Remove reference to self in children (hoping to remove circular dependencies)

Method Details

__init__(self, progress=False)
(Constructor)

Parameters:
progress - Print time progress on console?
Overrides:
PyFoam.LogAnalysis.FoamLogAnalyzer.FoamLogAnalyzer.__init__

addExpression(self, name, expr, idNr=None)

Add a RegExp
Parameters:
name - name of the RegExp
expr - the RegExp
idNr - number of the pattern group that identifies data-sets

getData(self, name, time=None, ID=None)

Get data
Parameters:
name - name of the RegExp
time - time from which the data set it to be read
ID - identification of the data set
Returns:
tuple with the data

getIDs(self, name)

Get a list with the available IDs

getTimes(self, name, ID=None)

Get a list with the available times for a specific ID

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