%
% API Documentation for nMOLDYN
% Module nMOLDYN.Core.Preferences
%
% Generated by epydoc 3.0.1
% [Thu Oct  8 17:00:00 2009]
%

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

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

    \label{nMOLDYN:Core:Preferences}
This modules stores some the nMOLDYN PREFERENCES variables that will be 
used throughout all nMOLDYN code.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Variables                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Variables}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\raggedright P\-R\-E\-F\-E\-R\-E\-N\-C\-E\-S\- & \raggedright \textbf{Value:} 
{\tt nMOLDYNPreferences()}&\\
\cline{1-2}
\end{longtable}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Preferences \textit{(module)}!nMOLDYN.Core.Preferences.nMOLDYNPreferences \textit{(class)}|(}
\subsection{Class nMOLDYNPreferences}

    \label{nMOLDYN:Core:Preferences:nMOLDYNPreferences}
\begin{tabular}{cccccc}
% Line for object, linespec=[False]
\multicolumn{2}{r}{\settowidth{\BCL}{object}\multirow{2}{\BCL}{object}}
&&
  \\\cline{3-3}
  &&\multicolumn{1}{c|}{}
&&
  \\
&&\multicolumn{2}{l}{\textbf{nMOLDYN.Core.Preferences.nMOLDYNPreferences}}
\end{tabular}

Class whose attributes defines the nMOLDYN PREFERENCES variables.

This class is built on the Singleton principle. That means that one and 
just one instances of that class will be created.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_new\_\_}(\textit{c})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
      \textbf{Return Value}
    \vspace{-1ex}

      \begin{quote}
      a new object with type S, a subtype of T

      \end{quote}

      Overrides: object.\_\_new\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}

    \label{nMOLDYN:Core:Preferences:nMOLDYNPreferences:__getattr__}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Preferences \textit{(module)}!nMOLDYN.Core.Preferences.nMOLDYNPreferences \textit{(class)}!nMOLDYN.Core.Preferences.nMOLDYNPreferences.\_\_getattr\_\_ \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_getattr\_\_}(\textit{self}, \textit{name})

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

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_setattr\_\_}(\textit{self}, \textit{name}, \textit{val})

\setlength{\parskip}{2ex}
    x.\_\_setattr\_\_('name', value) {\textless}=={\textgreater} x.name = 
    value

\setlength{\parskip}{1ex}
      Overrides: object.\_\_setattr\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}


\large{\textbf{\textit{Inherited from object}}}

\begin{quote}
\_\_delattr\_\_(), \_\_getattribute\_\_(), \_\_hash\_\_(), \_\_init\_\_(), \_\_reduce\_\_(), \_\_reduce\_ex\_\_(), \_\_repr\_\_(), \_\_str\_\_()
\end{quote}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                              Properties                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Properties}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\multicolumn{2}{|l|}{\textit{Inherited from object}}\\
\multicolumn{2}{|p{\varwidth}|}{\raggedright \_\_class\_\_}\\
\cline{1-2}
\end{longtable}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                            Class Variables                            %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Class Variables}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\raggedright i\-n\-s\-t\-a\-n\-c\-e\- & \raggedright \textbf{Value:} 
{\tt None}&\\
\cline{1-2}
\end{longtable}

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Preferences \textit{(module)}!nMOLDYN.Core.Preferences.nMOLDYNPreferences \textit{(class)}|)}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Preferences \textit{(module)}|)}
