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

Class CreateModuleFile

source code

                         object --+    
                                  |    
PyFoamApplication.PyFoamApplication --+
                                      |
                                     CreateModuleFile

Instance Methods [hide private]
 
__init__(self, args=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
addOptions(self)
Add options to the parser
source code
 
uniqifyPathEnvVar(self, pathEnvVar)
Remove all duplicates from PATH env var.
source code
 
removeComponentWithSubstrFromPathEnvVar(self, pathEnvVar, removeSubStr)
Remove components from PATH env var where a substring is present.
source code
 
removeComponentFromPathEnvVar(self, pathEnvVar, removePathComponents)
Remove components from PATH env var.
source code
 
writeModuleFileHeader(self, fid, version)
Write Modules file header
source code
 
writeModuleFileFooter(self, fid)
Write Modules file footer
source code
 
writeModuleEnvironmentEntry(self, fid, envVarDict, homeVar, userVar)
Write Modules file environment variables
source code
 
writeModuleAliasEntry(self, fid, aliasesVarDict, homeVar, userVar)
Write Modules file aliases
source code
 
run(self)
Run the real application
source code

Inherited from PyFoamApplication.PyFoamApplication: __getitem__, __iter__, addLocalConfig, addToCaseLog, checkCase, ensureGeneralOptions, error, getData, iteritems, iterkeys, setData, silent, warning

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, args=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) 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
  • inputApp - Application with input data. Used to allow a 'pipe-like' behaviour if the class is used from a Script
Overrides: object.__init__
(inherited documentation)

addOptions(self)

source code 

Add options to the parser

Overrides: PyFoamApplication.PyFoamApplication.addOptions
(inherited documentation)

uniqifyPathEnvVar(self, pathEnvVar)

source code 

Remove all duplicates from PATH env var. Order preserving

removeComponentWithSubstrFromPathEnvVar(self, pathEnvVar, removeSubStr)

source code 

Remove components from PATH env var where a substring is present. Order preserving

removeComponentFromPathEnvVar(self, pathEnvVar, removePathComponents)

source code 

Remove components from PATH env var. Order preserving

run(self)

source code 

Run the real application

Overrides: PyFoamApplication.PyFoamApplication.run
(inherited documentation)