Package nMOLDYN :: Package Core :: Module Config
[hide private]
[frames] | no frames]

Module Config

source code


This modules implements the procedures that handles nMOLDYN PREFERENCES.

Procedures:
    * saveConfigurationFile: saves a PREFERENCES file.
    * loadConfigurationFile: loads a PREFERENCES file.

Functions [hide private]
 
saveConfigurationFile(cfgFilename=None, config=PREFERENCES)
Saves |config| configuration to |cfgFilename| file name.
source code
 
loadConfigurationFile(cfgFilename=None, config=PREFERENCES)
Loads a configuration from |cfgFilename| file name and updates |config| PREFERENCES.
source code
Function Details [hide private]

saveConfigurationFile(cfgFilename=None, config=PREFERENCES)

source code 
Saves |config| configuration to |cfgFilename| file name.

@param cfgFilename: if not None, the name of the PREFERENCES file to save else the configuration file
    will be saved to a plat-form dependant location:
        -$USERPROFILE/Application Data/nMOLDYN/nMOLDYN.ini on Windows
        -$HOME/Library/Preferences/nMLDYN/nMOLDYN.pref on MacOS
        -$HOME/.nMOLDYN on Linux
@type: cfgFilename: string.

@param config: the configuration to save. By default, the default PREFERENCES stored in 
    nMOLDYN.Core.Preferences.nMOLDYNPreferences class.
@type config: instance of a dummy class whose attributes must be the ones defined in 
    nMOLDYN.Core.Preferences.nMOLDYNPreferences class.

loadConfigurationFile(cfgFilename=None, config=PREFERENCES)

source code 
Loads a configuration from |cfgFilename| file name and updates |config| PREFERENCES.

@param cfgFilename: if not None, the name of the PREFERENCES file to load else the configuration file
    will be loaded from a plat-form dependant location:
        -$USERPROFILE/Application Data/nMOLDYN/nMOLDYN.ini on Windows
        -$HOME/Library/Preferences/nMLDYN/nMOLDYN.pref on MacOS
        -$HOME/.nMOLDYN on Linux
@type: cfgFilename: string.

@param config: the configuration to load. By default, the default PREFERENCES stored in 
    nMOLDYN.Core.Preferences.nMOLDYNPreferences class.
@type config: instance of a dummy class whose attributes must be the ones defined in 
    nMOLDYN.Core.Preferences.nMOLDYNPreferences class.