%
% API Documentation for nMOLDYN
% Module nMOLDYN.GUI.AnalysisDialog
%
% 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.AnalysisDialog \textit{(module)}|(}
\section{Module nMOLDYN.GUI.AnalysisDialog}

    \label{nMOLDYN:GUI:AnalysisDialog}
\begin{alltt}
This modules implements I\{Analysis--{\textgreater}selected analysis\} dialog.

Classes:
    * AnalysisDialog: creates I\{Analysis--{\textgreater}selected analysis\} dialog used to setup and/orrun 
      an analysis.
\end{alltt}


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

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

    \label{nMOLDYN:GUI:AnalysisDialog:AnalysisDialog}
\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.AnalysisDialog.AnalysisDialog}}
\end{tabular}

Builds the dialog for nMOLDYN analysis.


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

  \subsubsection{Methods}

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

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{parent}, \textit{analysis}, \textit{trajectory})

    \vspace{-1.5ex}

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

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

      \begin{quote}
        \begin{Ventry}{xxxxxxxxxx}

          \item[parent]

          the parent widget.

          \item[analysis]

          the analysis to setup.

            {\it (type=a class object of one of the nMOLDYN.Analysis subclasses.)}

          \item[trajectory]

          the loaded trajectory.

            {\it (type=instance of MMTK.Trajectory.Trajectory class)}

        \end{Ventry}

      \end{quote}

    \end{boxedminipage}

    \label{nMOLDYN:GUI:AnalysisDialog:AnalysisDialog:body}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisDialog \textit{(module)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog \textit{(class)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog.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}
    Create dialog body. Return widget that should have initial focus.

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

    \label{nMOLDYN:GUI:AnalysisDialog:AnalysisDialog:buttonbox}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisDialog \textit{(module)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog \textit{(class)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog.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}
    Add standard button box.

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

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

    \vspace{0.5ex}

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

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

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

    \label{nMOLDYN:GUI:AnalysisDialog:AnalysisDialog:cancel}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisDialog \textit{(module)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog \textit{(class)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog.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:AnalysisDialog:AnalysisDialog:validate}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.AnalysisDialog \textit{(module)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog \textit{(class)}!nMOLDYN.GUI.AnalysisDialog.AnalysisDialog.validate \textit{(method)}}

    \vspace{0.5ex}

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

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

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

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

    \vspace{0.5ex}

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

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

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

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

    \vspace{0.5ex}

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

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

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Estimates the time taken by the analysis directly from the GUI.

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

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

    \vspace{0.5ex}

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

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

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Saves a python script of the analysis that can be run independantly of 
    the GUI.

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

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

    \vspace{0.5ex}

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

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

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Runs the analysis directly from the GUI.

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

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

    \vspace{0.5ex}

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

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

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This method is called when the user presses the 'Save and Run' button 
    of an analysis dialog. It saves a python script of the analysis and run
    the analysis directly from the GUI.

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

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

    \vspace{0.5ex}

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

    \raggedright \textbf{widgetsState}(\textit{self}, \textit{widget}, \textit{state}={\tt DISABLED})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This method is launched when an analysis is run from the GUI. Il will 
    disable all the widgets of the analysis dialog.

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

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