%
% API Documentation for nMOLDYN
% Module nMOLDYN.Core.Config
%
% Generated by epydoc 3.0.1
% [Thu Oct  8 16:59:59 2009]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Config \textit{(module)}|(}
\section{Module nMOLDYN.Core.Config}

    \label{nMOLDYN:Core:Config}
\begin{alltt}

This modules implements the procedures that handles nMOLDYN PREFERENCES.

Procedures:
    * saveConfigurationFile: saves a PREFERENCES file.
    * loadConfigurationFile: loads a PREFERENCES file.
\end{alltt}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Functions                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Functions}

    \label{nMOLDYN:Core:Config:saveConfigurationFile}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Config \textit{(module)}!nMOLDYN.Core.Config.saveConfigurationFile \textit{(function)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{saveConfigurationFile}(\textit{cfgFilename}={\tt None}, \textit{config}={\tt PREFERENCES})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
\begin{alltt}
Saves {\textbar}config{\textbar} configuration to {\textbar}cfgFilename{\textbar} 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.
\end{alltt}

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:Core:Config:loadConfigurationFile}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Config \textit{(module)}!nMOLDYN.Core.Config.loadConfigurationFile \textit{(function)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{loadConfigurationFile}(\textit{cfgFilename}={\tt None}, \textit{config}={\tt PREFERENCES})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
\begin{alltt}
Loads a configuration from {\textbar}cfgFilename{\textbar} file name and updates {\textbar}config{\textbar} 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.
\end{alltt}

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Config \textit{(module)}|)}
