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

Class UtilityRunner

source code

                       object --+            
                                |            
    AnalyzedCommon.AnalyzedCommon --+        
                                    |        
StepAnalyzedCommon.StepAnalyzedCommon --+    
                                        |    
                           object --+   |    
                                    |   |    
              BasicRunner.BasicRunner --+    
                                        |    
            AnalyzedRunner.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

Instance Methods [hide private]
 
__init__(self, argv=None, silent=False, logname="PyFoamUtility", server=False, restart=False, compressLog=False, noLog=False, remark=None, jobId=None)
see BasicRunner
source code
 
add(self, name, exp, idNr=None)
adds a regular expression
source code
 
get(self, name, time=None, ID=None)
get a data set
source code
 
getIDs(self, name)
get a list of all the IDs
source code
 
getTimes(self, name, ID=None)
get a list of all the times that are available for ID
source code

Inherited from AnalyzedRunner.AnalyzedRunner: firstClockTime, firstCpuTime, lastTime, lineHandle, stopHandle, totalClockTime, totalCpuTime

Inherited from StepAnalyzedCommon.StepAnalyzedCommon: timeChanged, timeHandle

Inherited from AnalyzedCommon.AnalyzedCommon: addAnalyzer, addTrigger, createPlots, getAnalyzer, getDirname, getTime, hasAnalyzer, listAnalyzers, picklePlots, reset, tearDown

Inherited from BasicRunner.BasicRunner: addEndTrigger, getSolutionDirectory, logName, runOK, start, startHandle, stopGracefully, writeResults

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, argv=None, silent=False, logname="PyFoamUtility", server=False, restart=False, compressLog=False, noLog=False, remark=None, jobId=None)
(Constructor)

source code 

see BasicRunner

Parameters:
  • analyzer - the analyzer for the output argv, silent, logname, server, lam, noLog - see BasicRunner
Overrides: object.__init__

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

source code 

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)

source code 

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