Package PyFoam :: Package Paraview :: Module StateFile :: Class StateFile
[hide private]
[frames] | no frames]

Class StateFile

source code

object --+
         |
        StateFile

The actual PVSM-file

Stores the actual file as an xml-file

Instance Methods [hide private]
 
__init__(self, fName)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
readerType(self)
Returns the type of the used OF-Reader as a string
source code
 
setCase(self, case)
Rewrite the state-file so that it uses another case than the one predefined in the state-file
source code
 
__str__(self)
Write the file as a string
source code
 
writeTemp(self)
Write the state to a temporary file and return the name of that file
source code
 
serverState(self) source code
 
getProxy(self, type_)
Return a list of Prxy-elements that fit a specific type
source code
 
getReader(self)
Return the Proxy-Element with the reader
source code
 
rewriteTexts(self, values)
Rewrite all Text-Objects so that strings of the form %%(key)s get replaced
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, fName)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • fName - the XML-file that represents the Paraview-state
Overrides: object.__init__

setCase(self, case)

source code 

Rewrite the state-file so that it uses another case than the one predefined in the state-file

Parameters:
  • case - The path to the new case-file

__str__(self)
(Informal representation operator)

source code 

Write the file as a string

Overrides: object.__str__

rewriteTexts(self, values)

source code 

Rewrite all Text-Objects so that strings of the form %%(key)s get replaced

Parameters:
  • values - dictionary with the values