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

Class LogLineAnalyzer

source code


Base class for the analysis of all lines from a OpenFOAM-log

Lines are available one at a time

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
addListener(self, func) source code
 
doAnalysis(self, line)
Analyze a line
source code
 
getCurrentData(self)
Give back the current analyzed data in a dictionary
source code
 
getTime(self)
Returns: current time
source code
 
goOn(self)
If the analyzer thinks the simulation should be stopped (for instance because of convergence) it returns false
source code
 
notify(self, *data)
Notifys the event listeners of an event
source code
 
setDirectory(self, oDir)
Set the directory to which output is to be written (if any output is written)
source code
 
setParent(self, parent)
Introduces the LineAnalyzer to its supervisor
source code
 
tearDown(self)
Hook to let every analyzer give its stuff back when the analysis has ended
source code
 
timeChanged(self)
The value of the time has changed in the Log-file
source code
 
writeProgress(self, msg)
Let the parent write an additional progress message
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

addListener(self, func)

source code 
Parameters:
  • func - a new listener-function that gets notified every time the line-analyzer encounters something interesting

doAnalysis(self, line)

source code 

Analyze a line

line - the line to be analyzed

This method carries the main functionality in the sub-classes

getCurrentData(self)

source code 

Give back the current analyzed data in a dictionary

To be overwritten by subclasses

getTime(self)

source code 
Returns:
current time

notify(self, *data)

source code 

Notifys the event listeners of an event

Parameters:
  • data - The data of the event. Everything is possible

setParent(self, parent)

source code 

Introduces the LineAnalyzer to its supervisor

Parameters:
  • parent - The Analyzer class of which this is a part

timeChanged(self)

source code 

The value of the time has changed in the Log-file

For subclasses that need to know the current time