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

Class GeneralLineAnalyzer

source code


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

Combines the capabilities of TimeLineLineAnalyzer and FileLineAnalyzer

Instance Methods [hide private]
 
__init__(self, doTimelines=False, doFiles=False, titles=[], accumulation=None, singleFile=False, progressTemplate=None, startTime=None, endTime=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
addToFiles(self, match)
Method that adds matched data to files
source code
 
addToTimelines(self, match)
Method that adds matched data to timelines
source code
 
doAnalysis(self, line)
General analysis method.
source code
 
endAnalysis(self, match)
Method at the end of a successfull match
source code
 
getCurrentData(self)
Give back the current analyzed data in a dictionary
source code
 
getTimeline(self, name)
Returns: the timeline as two list: the times and the values
source code
 
setDirectory(self, oDir)
Creates the OutFileCollection-object
source code
 
setMaster(self, master)
Assign another line-analyzer that will do the actual data gathering
source code
 
setTitles(self, titles)
Sets the titles anew
source code
 
startAnalysis(self, match)
Method at the start of a successfull match
source code
 
tearDown(self)
Closes files
source code
 
timeChanged(self)
Sets the current time in the timelines
source code

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

    Inherited from LogLineAnalyzer.LogLineAnalyzer
 
addListener(self, func) 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
 
setParent(self, parent)
Introduces the LineAnalyzer to its supervisor
source code
 
writeProgress(self, msg)
Let the parent write an additional progress message
source code
Static Methods [hide private]
 
fName(n) source code
 
setPhase(p='') source code
Class Variables [hide private]
  __phase = ''
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, doTimelines=False, doFiles=False, titles=[], accumulation=None, singleFile=False, progressTemplate=None, startTime=None, endTime=None)
(Constructor)

source code 

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

Parameters:
  • titles - The titles of the data elements
  • progressTemplate - Progress output to be reported
Overrides: object.__init__

addToFiles(self, match)

source code 

Method that adds matched data to files

Parameters:
  • match - data matched by a regular expression

addToTimelines(self, match)

source code 

Method that adds matched data to timelines

Parameters:
  • match - data matched by a regular expression

doAnalysis(self, line)

source code 

General analysis method. Derived classes should instead override callbacks

Overrides: LogLineAnalyzer.LogLineAnalyzer.doAnalysis

getCurrentData(self)

source code 

Give back the current analyzed data in a dictionary

To be overwritten by subclasses

Overrides: LogLineAnalyzer.LogLineAnalyzer.getCurrentData
(inherited documentation)

getTimeline(self, name)

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

setDirectory(self, oDir)

source code 

Creates the OutFileCollection-object

Overrides: LogLineAnalyzer.LogLineAnalyzer.setDirectory

setTitles(self, titles)

source code 

Sets the titles anew

Parameters:
  • titles - the new titles

tearDown(self)

source code 

Closes files

Overrides: LogLineAnalyzer.LogLineAnalyzer.tearDown

timeChanged(self)

source code 

Sets the current time in the timelines

Overrides: LogLineAnalyzer.LogLineAnalyzer.timeChanged