Package PyFoam :: Package Execution :: Module UtilityRunner :: Class UtilityRunner
[show private | hide private]
[frames | no frames]

Class UtilityRunner

AnalyzedCommon --+    
                 |    
   BasicRunner --+    
                 |    
    AnalyzedRunner --+
                     |
                    UtilityRunner


To this runner regular expressions can be added. Each line is checked against each regular expression and saved with the corresponding time.

Each RegEx has a name

For each pattern group in the RegEx one data value is stored
Method Summary
  __init__(self, argv, silent, logname, server)
see BasicRunner
  add(self, name, exp, idNr)
adds a regular expression
  get(self, name, time, ID)
get a data set
  getIDs(self, name)
get a list of all the IDs
  getTimes(self, name, ID)
get a list of all the times that are available for ID
    Inherited from AnalyzedCommon
  addAnalyzer(self, name, analyzer)
  getAnalyzer(self, name)
  getDirname(self)
Get the name of the directory where the data is written to
  getTime(self)
Get the execution time
  lineHandle(self, line)
Not to be called: calls the analyzer for the current line
  reset(self)
reset the analyzer
  tearDown(self)
    Inherited from BasicRunner
PyFoam.RunDictionary.SolutionDirectory getSolutionDirectory(self, archive)
Return the directory of the case
  logName(self)
Get the name of the logfiles
  runOK(self)
checks whether the run was successful
  start(self)
starts the command and stays with it till the end
  startHandle(self)
to be called before the program is started
  stopHandle(self)
called after the program has stopped

Method Details

__init__(self, argv=None, silent=False, logname='PyFoamUtility', server=False)
(Constructor)

see BasicRunner
Overrides:
PyFoam.Execution.AnalyzedRunner.AnalyzedRunner.__init__

add(self, name, exp, idNr=None)

adds a regular expression

name - name under whcih the RegExp is known exp - the regular expression idNr - number of the pattern group that is used to make a data set unique

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

get a data set

name - name of the RegExp time - at which time (if unset the last time is used) ID - the unique ID determined by idNr

getIDs(self, name)

get a list of all the IDs

getTimes(self, name, ID=None)

get a list of all the times that are available for ID

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