Package PyFoam :: Package Infrastructure :: Module Hardcoded
[hide private]
[frames] | no frames]

Module Hardcoded

source code

Hardcoded values

Functions [hide private]
 
globalDirectory()
Returns: the global directory
source code
 
globalConfigFile()
Returns: The name of the global configuration File
source code
 
globalConfigDir()
Returns: The name of the global configuration directory where .cfg-files can be placed
source code
 
userDirectory()
Returns: the user directory
source code
 
userConfigFile()
Returns: The name of the user configuration File
source code
 
userConfigDir()
Returns: The name of the user configuration directory where .cfg-files can be placed
source code
 
userName()
Returns: name of the current user
source code
 
logDirectory()
Path to the log directory that this user may write to.
source code
 
assertDirectory(name)
Makes sure that the directory exists
source code
Variables [hide private]
  _pyFoamDirName = "pyFoam"
  _pyFoamConfigName = "pyfoamrc"
Function Details [hide private]

globalDirectory()

source code 
Returns:
the global directory

globalConfigFile()

source code 
Returns:
The name of the global configuration File

globalConfigDir()

source code 
Returns:
The name of the global configuration directory where .cfg-files can be placed

userDirectory()

source code 
Returns:
the user directory

userConfigFile()

source code 
Returns:
The name of the user configuration File

userConfigDir()

source code 
Returns:
The name of the user configuration directory where .cfg-files can be placed

userName()

source code 
Returns:
name of the current user

logDirectory()

source code 

Path to the log directory that this user may write to. /var/log/pyFoam for root, ~/.pyFoam/log for all others

Returns:
path to the log directory.

assertDirectory(name)

source code 

Makes sure that the directory exists

Parameters:
  • name - the directory