Package PyFoam :: Package RunDictionary :: Module ParsedParameterFile :: Class ParsedFileHeader
[hide private]
[frames] | no frames]

Class ParsedFileHeader

source code

                object --+                
                         |                
Basics.Utilities.Utilities --+            
                             |            
           FileBasis.FileBasis --+        
                                 |        
         FileBasis.FileBasisBackup --+    
                                     |    
                   ParsedParameterFile --+
                                         |
                                        ParsedFileHeader

Only parse the header of a file

Instance Methods [hide private]
 
__init__(self, name)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__getitem__(self, name) source code
 
__contains__(self, name) source code
 
__len__(self) source code

Inherited from ParsedParameterFile: __delitem__, __iter__, __setitem__, __str__, parse

Inherited from FileBasis.FileBasisBackup: restore

Inherited from FileBasis.FileBasis: baseName, closeFile, copyRest, getCaseDir, goMatch, goTo, makeTemp, openFile, purgeFile, readFile, realName, writeFile, writeFileAs

Inherited from Basics.Utilities.Utilities: copyfile, copytree, execute, listDirectory, remove, rmtree, writeDictionaryHeader

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

Class Variables [hide private]

Inherited from FileBasis.FileBasisBackup: counter

Inherited from FileBasis.FileBasis: addedString, removedString

Inherited from Basics.Utilities.Utilities: excludeNames

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name)
(Constructor)

source code 

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

Parameters:
  • name - The name of the parameter file
  • backup - create a backup-copy of the file
  • boundaryDict - the file to parse is a boundary file
  • listDict - the file only contains a list
  • listDictWithHeader - the file only contains a list and a header
  • listLengthUnparsed - Lists longer than that length are not parsed
  • binaryMode - Parse long lists in binary mode (to be overridden by the settings in the header
  • noHeader - don't expect a header
  • noBody - don't read the body of the file (only the header)
  • doMacroExpansion - expand #include and $var
  • noVectorOrTensor - short lists of length 3, 6 an 9 are NOT interpreted as vectors or tensors
  • dontRead - Do not read the file during construction
  • longListOutputThreshold - Lists that are longer than this are prefixed with a length
Overrides: object.__init__
(inherited documentation)

__getitem__(self, name)
(Indexing operator)

source code 
Overrides: ParsedParameterFile.__getitem__

__contains__(self, name)
(In operator)

source code 
Overrides: ParsedParameterFile.__contains__

__len__(self)
(Length operator)

source code 
Overrides: ParsedParameterFile.__len__