Package PyFoam :: Package Applications :: Module CaseBuilder :: Class CaseBuilder
[hide private]
[frames] | no frames]

Class CaseBuilder

source code

                         object --+    
                                  |    
PyFoamApplication.PyFoamApplication --+
                                      |
                         object --+   |
                                  |   |
CommonCaseBuilder.CommonCaseBuilder --+
                                      |
                                     CaseBuilder

Instance Methods [hide private]
 
__init__(self, args=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
addOptions(self)
Add options to the parser
source code
 
printTitle(self, title) source code
 
run(self)
Run the real application
source code
 
buildUsage(self, args) source code

Inherited from PyFoamApplication.PyFoamApplication: addLocalConfig, addToCaseLog, checkCase, ensureGeneralOptions, error, silent, warning

Inherited from CommonCaseBuilder.CommonCaseBuilder: pathInfo, searchDescriptionFile

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, args=None)
(Constructor)

source code 

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

Parameters:
  • description - description of the command
  • usage - Usage
  • interspersed - Is the command line allowed to be interspersed (options after the arguments)
  • args - Command line arguments when using the Application as a 'class' from a script
  • nr - Number of required arguments
  • changeVersion - May this application change the version of OF used?
  • exactNr - Must not have more than the required number of arguments
Overrides: object.__init__
(inherited documentation)

addOptions(self)

source code 

Add options to the parser

Overrides: CommonCaseBuilder.CommonCaseBuilder.addOptions

run(self)

source code 

Run the real application

Overrides: PyFoamApplication.PyFoamApplication.run
(inherited documentation)