PyFoam.Basics.BasicFile module

Basic file output

class PyFoam.Basics.BasicFile.BasicFile(name)

Bases: object

File for data output

The format of the file is: one data-set per line Values are separated by tabs

The file is created the first time it is written

__dict__ = mappingproxy({'__module__': 'PyFoam.Basics.BasicFile', '__doc__': 'File for data output\n\n    The format of the file is: one data-set per line\n    Values are separated by tabs\n\n    The file is created the first time it is written', '__init__': <function BasicFile.__init__>, 'outputAtStart': <function BasicFile.outputAtStart>, 'outputAtEnd': <function BasicFile.outputAtEnd>, 'outputAtLineEnd': <function BasicFile.outputAtLineEnd>, 'outputAtLineStart': <function BasicFile.outputAtLineStart>, 'callAtOpen': <function BasicFile.callAtOpen>, 'callAtClose': <function BasicFile.callAtClose>, 'getHandle': <function BasicFile.getHandle>, 'writeLine': <function BasicFile.writeLine>, 'close': <function BasicFile.close>, '__dict__': <attribute '__dict__' of 'BasicFile' objects>, '__weakref__': <attribute '__weakref__' of 'BasicFile' objects>, '__annotations__': {}})

__init__(name)

name - name of the file

__module__ = 'PyFoam.Basics.BasicFile'

__weakref__

list of weak references to the object (if defined)

callAtClose()

A hook that gets called when the file is closed

callAtOpen()

A hook that gets called when the file is opened

close(temporary=False)

close the file :param temporary: only close the file temporary (to be appended on later)

getHandle()

get the file-handle. File is created and opened if it wasn’t opened before

outputAtEnd()

A hook for outputting stuff at the end of the file

outputAtLineEnd()

A hook for outputting stuff at the end of each line

outputAtLineStart()

A hook for outputting stuff at the start of each line

outputAtStart()

A hook for outputting stuff at the beginning of the file

writeLine(data)

write a data set

data - a tuple with the data-set