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

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

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}|(}
\section{Module nMOLDYN.GUI.AnalysisBenchmarkDialog}

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog}
\begin{alltt}
This modules implements I\{Help--{\textgreater}nMOLDYN benchmark\} dialog.

Classes:
    * AnalysisBenchmarkDialog: creates I\{Help--{\textgreater}nMOLDYN benchmark\} dialog used to run the stability tests 
      between nMOLDYN v2.2.5 and the current version of nMOLDYN.
\end{alltt}


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

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}|(}
\subsection{Class AnalysisBenchmarkDialog}

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

Builds the dialog for nMOLDYN analysis benchmarks.

These benchmarks will guarantee the stability of the current version with a
reference one that is the version 2.2.5 the last official release of 
nMOLDYN.

\textbf{Note:} these benchmarks should be performed every time the code source of nMOLDYN 
has been touched for any reason.




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

  \subsubsection{Methods}

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:__init__}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.\_\_init\_\_ \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{parent}, \textit{title}={\tt None})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    The constructor.

\setlength{\parskip}{1ex}
      \textbf{Parameters}
      \vspace{-1ex}

      \begin{quote}
        \begin{Ventry}{xxxxxx}

          \item[parent]

          the parent widget.

          \item[title]

          a string specifying the title of the dialog.

            {\it (type=string)}

        \end{Ventry}

      \end{quote}

    \end{boxedminipage}

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:body}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.body \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{body}(\textit{self}, \textit{master})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Creates dialog body. Returns widget that should have initial focus.

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:buttonbox}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.buttonbox \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{buttonbox}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Adds standard button box.

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:ok}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.ok \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{ok}(\textit{self}, \textit{event}={\tt None})

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:cancel}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.cancel \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{cancel}(\textit{self}, \textit{event}={\tt None})

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:validate}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.validate \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{validate}(\textit{self})

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:apply}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.apply \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{apply}(\textit{self})

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:infoAboutTest}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.infoAboutTest \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{infoAboutTest}(\textit{self}, \textit{event})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This callback displays basic information about a selected test before 
    running it by clicking on the right mouse button.

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:displayTest}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.displayTest \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{displayTest}(\textit{self}, \textit{event}, \textit{parameters})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Displays in a text widget the nMOLDYN v2.2.5 input file of a selected 
    failing test.

    Arguments:

    \begin{itemize}
    \setlength{\parskip}{0.6ex}
      \item event: the mouse left button click Tkinter event that will trigger 
        the opening of the window.

      \item testSet: the test set to which belong the failing test.

    \end{itemize}

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:cancel1}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.cancel1 \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{cancel1}(\textit{self}, \textit{event}={\tt None})

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

    \label{nMOLDYN:GUI:AnalysisBenchmarkDialog:AnalysisBenchmarkDialog:clearResults}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog.clearResults \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{clearResults}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This methods clears up all the results about the evaluated test sets.

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

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}!nMOLDYN.GUI.AnalysisBenchmarkDialog.AnalysisBenchmarkDialog \textit{(class)}|)}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisBenchmarkDialog \textit{(module)}|)}
