Package PyFoam :: Package Basics :: Module OutputFile :: Class OutputFile
[hide private]
[frames] | no frames]

Class OutputFile

source code

         object --+    
                  |    
BasicFile.BasicFile --+
                      |
                     OutputFile

output of time dependent data

Instance Methods [hide private]
 
__init__(self, name, titles=[], parent=None)
name - name of the file
source code
 
setTitles(self, titles)
Sets the titles anew.
source code
 
outputAtStart(self)
Write column titles if present
source code
 
write(self, time, data)
write data set
source code
 
callAtOpen(self)
A hook that gets called when the file is opened
source code
 
callAtClose(self)
A hook that gets called when the file is closed
source code
 
__repr__(self)
Output for debugging
source code

Inherited from BasicFile.BasicFile: close, getHandle, outputAtEnd, outputAtLineEnd, outputAtLineStart, writeLine

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, titles=[], parent=None)
(Constructor)

source code 

name - name of the file

Parameters:
  • name - name of the file
  • titles - Titles of the columns
  • parent - A parent collection that knows about opened and closed files
Overrides: object.__init__

setTitles(self, titles)

source code 

Sets the titles anew. Only has an effect if the file hasn't been opened yet

Parameters:
  • titles - The new titles

outputAtStart(self)

source code 

Write column titles if present

Overrides: BasicFile.BasicFile.outputAtStart

write(self, time, data)

source code 

write data set

Parameters:
  • time - the current time
  • data - tuple with data

callAtOpen(self)

source code 

A hook that gets called when the file is opened

Overrides: BasicFile.BasicFile.callAtOpen

callAtClose(self)

source code 

A hook that gets called when the file is closed

Overrides: BasicFile.BasicFile.callAtClose

__repr__(self)
(Representation operator)

source code 

Output for debugging

Overrides: object.__repr__