600 lines
29 KiB
TeX
600 lines
29 KiB
TeX
\doxysection{PAdmin Class Reference}
|
|
\hypertarget{classPAdmin}{}\label{classPAdmin}\index{PAdmin@{PAdmin}}
|
|
|
|
|
|
The \doxylink{classPAdmin}{PAdmin} class is the main administration class for musr\+Wiz.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$PAdmin.\+h$>$}
|
|
|
|
Inheritance diagram for PAdmin\+:\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.000000cm]{classPAdmin}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classPAdmin_a26348be83d7a51fe92c8c9e1338873e6}{PAdmin}} ()
|
|
\begin{DoxyCompactList}\small\item\em Constructor. Loads all configuration files. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPAdmin_a68520fd58170329ec88b437129b4202b}{\texorpdfstring{$\sim$}{\string~}\+PAdmin}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{classPAdmin_aaad5594e8308f0d6ff3e1c3526c2e8cb}{Is\+Valid}} ()
|
|
\begin{DoxyCompactList}\small\item\em Checks if the admin object was initialized successfully. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPAdmin_a24cd57e2549240e4cb3c4596d0c85838}{dump}} (int tag)
|
|
\begin{DoxyCompactList}\small\item\em Dumps debug information to stdout. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPAdmin_a8a6d21a780001e04aa574bf6375a49ed}{get\+Default\+Institute}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the default institute name. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPAdmin_a101e10eaa97dbd18b5d1a77bdcb68abb}{get\+Default\+Instrument}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the default instrument name. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPAdmin_a39c27a476646c72533bfeed22a4f7f56}{get\+Default\+Fit\+Type}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the default fit type. \end{DoxyCompactList}\item
|
|
QString\+List \mbox{\hyperlink{classPAdmin_aab992ae2a9f2be57a5086eaeec840490}{get\+Institute\+List}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns a list of all available institute names. \end{DoxyCompactList}\item
|
|
QString\+List \mbox{\hyperlink{classPAdmin_abab05fd73a15a3d602b7c09321f3bca6}{get\+Instrument\+List}} (QString institute)
|
|
\begin{DoxyCompactList}\small\item\em Returns a list of instruments for a given institute. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPInstrument}{PInstrument}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPAdmin_afc4369f2149dc374f8c7f6d31cc65f35}{get\+Instrument}} (QString institute, QString instrument)
|
|
\begin{DoxyCompactList}\small\item\em Returns a pointer to an instrument object. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classPAdmin_a037ef69fa93c00d62ed6bb79c7598695}{get\+Theo\+Template\+Size}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the number of theory templates. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPTheoTemplate}{PTheo\+Template}} $>$ \mbox{\hyperlink{classPAdmin_af29f6624a5d15de8c4f2254679b4bd87}{get\+Theo\+Templates}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns all theory templates. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPTheoTemplate}{PTheo\+Template}} \mbox{\hyperlink{classPAdmin_a0e56beee97bf8b692f75dde09b0439f3}{get\+Theo\+Template}} (int idx)
|
|
\begin{DoxyCompactList}\small\item\em Returns a theory template by index. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classPAdmin_aac48723474479dd8bf8f6cb8c88523e4}{get\+Musrfit\+Func\+Size}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the number of musrfit functions. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPMusrfitFunc}{PMusrfit\+Func}} $>$ \mbox{\hyperlink{classPAdmin_a0e6296de6e1994afb419c36d0864122e}{get\+Musrfit\+Func}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns all musrfit functions. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPMusrfitFunc}{PMusrfit\+Func}} \mbox{\hyperlink{classPAdmin_a92a8881fc004f7c50b261f9af795169e}{get\+Musrfit\+Func}} (QString name)
|
|
\begin{DoxyCompactList}\small\item\em Returns a musrfit function by name or abbreviation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Protected Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
int \mbox{\hyperlink{classPAdmin_abc1f684dd27cae1baf3fab1cb688a0b9}{add\+Instrument}} (QString institute, \mbox{\hyperlink{classPInstrument}{PInstrument}} instrument)
|
|
\begin{DoxyCompactList}\small\item\em Adds an instrument to an institute. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
int \mbox{\hyperlink{classPAdmin_a8349feaf916f9efdb5c1263f19d5b7a0}{load\+Musr\+Wiz\+Default}} (QString fln)
|
|
\begin{DoxyCompactList}\small\item\em Loads the musr\+Wiz.\+xml default settings file. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classPAdmin_ab9bfe3e58e4c460fe5a977313ad1c8dd}{load\+Musrfit\+Func}} (QString fln)
|
|
\begin{DoxyCompactList}\small\item\em Loads the musrfit\+\_\+funcs.\+xml file. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classPAdmin_a7ae5802442b73cf5b01592c31f141637}{load\+Instrument\+Def}} (QString path, QString fln)
|
|
\begin{DoxyCompactList}\small\item\em Loads an instrument definition XML file. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
bool \mbox{\hyperlink{classPAdmin_a2584c56be1b93c48494fa0defd054c8d}{f\+Valid}}
|
|
\begin{DoxyCompactList}\small\item\em flag indicating successful initialization \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPMusrWizDefault}{PMusr\+Wiz\+Default}} \mbox{\hyperlink{classPAdmin_a3527c85b4a575d5bd3adb0396275dd90}{f\+Default}}
|
|
\begin{DoxyCompactList}\small\item\em default wizard settings \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPInstitute}{PInstitute}} $>$ \mbox{\hyperlink{classPAdmin_a6dd0a70a12002db8b232e783f3ea072d}{f\+Institute}}
|
|
\begin{DoxyCompactList}\small\item\em list of institutes with their instruments \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPTheoTemplate}{PTheo\+Template}} $>$ \mbox{\hyperlink{classPAdmin_ac3e9c2b6d3d893515cce7e71bbc140fc}{f\+Theo\+Template}}
|
|
\begin{DoxyCompactList}\small\item\em list of theory templates \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPMusrfitFunc}{PMusrfit\+Func}} $>$ \mbox{\hyperlink{classPAdmin_acd01fdc4c16e0e22ddebe523a37b3f12}{f\+Musrfit\+Func}}
|
|
\begin{DoxyCompactList}\small\item\em list of musrfit functions \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Friends}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classPAdmin_a09464be8302897327f9ea74b90e55b7f}{PFunc\+XMLParser}}
|
|
\item
|
|
class \mbox{\hyperlink{classPAdmin_a27cac88a70cf6e149c6544ff3ef4d73d}{PInstrument\+Def\+XMLParser}}
|
|
\item
|
|
class \mbox{\hyperlink{classPAdmin_af1be044375687ef9b270f2ae4a075289}{PMusr\+Wiz\+Default\+XMLParser}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
The \doxylink{classPAdmin}{PAdmin} class is the main administration class for musr\+Wiz.
|
|
|
|
This class serves as the central repository for all configuration data needed by the musr\+Wiz application. It loads and manages\+:
|
|
\begin{DoxyItemize}
|
|
\item Default wizard settings from musr\+Wiz.\+xml
|
|
\item Musrfit function definitions and theory templates from musrfit\+\_\+funcs.\+xml
|
|
\item Instrument definitions from instrument\+\_\+def\+\_\+\texorpdfstring{$\ast$}{*}.xml files
|
|
\end{DoxyItemize}
|
|
|
|
The XML parser friend classes populate this class with data from the configuration files.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classPAdmin_a26348be83d7a51fe92c8c9e1338873e6}\index{PAdmin@{PAdmin}!PAdmin@{PAdmin}}
|
|
\index{PAdmin@{PAdmin}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{PAdmin()}{PAdmin()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a26348be83d7a51fe92c8c9e1338873e6}
|
|
PAdmin\+::\+PAdmin (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Constructor. Loads all configuration files.
|
|
|
|
Attempts to load configuration files first from the local directory, then from \$\+HOME/.musrfit/musr\+Wiz/. If files don\textquotesingle{}t exist, creates them from built-\/in resources.
|
|
|
|
Initializes that \doxylink{classPAdmin}{PAdmin} object, and calls the XML parser which feeds the object variables. \Hypertarget{classPAdmin_a68520fd58170329ec88b437129b4202b}\index{PAdmin@{PAdmin}!````~PAdmin@{\texorpdfstring{$\sim$}{\string~}PAdmin}}
|
|
\index{````~PAdmin@{\texorpdfstring{$\sim$}{\string~}PAdmin}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PAdmin()}{\string~PAdmin()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a68520fd58170329ec88b437129b4202b}
|
|
PAdmin\+::\texorpdfstring{$\sim$}{\string~}\+PAdmin (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{classPAdmin_abc1f684dd27cae1baf3fab1cb688a0b9}\index{PAdmin@{PAdmin}!addInstrument@{addInstrument}}
|
|
\index{addInstrument@{addInstrument}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{addInstrument()}{addInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_abc1f684dd27cae1baf3fab1cb688a0b9}
|
|
int PAdmin\+::add\+Instrument (\begin{DoxyParamCaption}\item[{QString}]{institute}{, }\item[{\mbox{\hyperlink{classPInstrument}{PInstrument}}}]{instrument}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Adds an instrument to an institute.
|
|
|
|
\doxylink{classPAdmin_abc1f684dd27cae1baf3fab1cb688a0b9}{PAdmin\+::add\+Instrument} adds an instrument to an institute.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em institute} & Institute name. Creates the institute if it doesn\textquotesingle{}t exist. \\
|
|
\hline
|
|
{\em instrument} & Instrument object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success.
|
|
\end{DoxyReturn}
|
|
Searches for the specified institute. If found, adds the instrument to it. If the institute doesn\textquotesingle{}t exist, creates a new institute entry and adds the instrument to it.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em institute} & Institute name (e.\+g., "{}\+PSI"{}). \\
|
|
\hline
|
|
{\em instrument} & Instrument object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a24cd57e2549240e4cb3c4596d0c85838}\index{PAdmin@{PAdmin}!dump@{dump}}
|
|
\index{dump@{dump}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{dump()}{dump()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a24cd57e2549240e4cb3c4596d0c85838}
|
|
void PAdmin\+::dump (\begin{DoxyParamCaption}\item[{int}]{tag}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Dumps debug information to stdout.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em tag} & Debug tag\+: 0=instrument defs, 1=musrfit funcs, 2=both, -\/1=none.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
dump all the instrument defs to stdout. This routine is there for debug purposes only. \Hypertarget{classPAdmin_a39c27a476646c72533bfeed22a4f7f56}\index{PAdmin@{PAdmin}!getDefaultFitType@{getDefaultFitType}}
|
|
\index{getDefaultFitType@{getDefaultFitType}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getDefaultFitType()}{getDefaultFitType()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a39c27a476646c72533bfeed22a4f7f56}
|
|
QString PAdmin\+::get\+Default\+Fit\+Type (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the default fit type.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Default fit type string from musr\+Wiz.\+xml.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a8a6d21a780001e04aa574bf6375a49ed}\index{PAdmin@{PAdmin}!getDefaultInstitute@{getDefaultInstitute}}
|
|
\index{getDefaultInstitute@{getDefaultInstitute}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getDefaultInstitute()}{getDefaultInstitute()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a8a6d21a780001e04aa574bf6375a49ed}
|
|
QString PAdmin\+::get\+Default\+Institute (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the default institute name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Default institute name from musr\+Wiz.\+xml.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a101e10eaa97dbd18b5d1a77bdcb68abb}\index{PAdmin@{PAdmin}!getDefaultInstrument@{getDefaultInstrument}}
|
|
\index{getDefaultInstrument@{getDefaultInstrument}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getDefaultInstrument()}{getDefaultInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a101e10eaa97dbd18b5d1a77bdcb68abb}
|
|
QString PAdmin\+::get\+Default\+Instrument (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the default instrument name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Default instrument name from musr\+Wiz.\+xml.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_aab992ae2a9f2be57a5086eaeec840490}\index{PAdmin@{PAdmin}!getInstituteList@{getInstituteList}}
|
|
\index{getInstituteList@{getInstituteList}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getInstituteList()}{getInstituteList()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_aab992ae2a9f2be57a5086eaeec840490}
|
|
QString\+List PAdmin\+::get\+Institute\+List (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a list of all available institute names.
|
|
|
|
\doxylink{classPAdmin_aab992ae2a9f2be57a5086eaeec840490}{PAdmin\+::get\+Institute\+List} returns a list of all available institute names.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
QString\+List containing all institute names.
|
|
\end{DoxyReturn}
|
|
Iterates through all loaded institutes and collects their names into a QString\+List.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
QString\+List containing all institute names (e.\+g., "{}\+PSI"{}, "{}\+TRIUMF"{}, "{}\+ISIS"{}, "{}\+J-\/\+PARC"{}).
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_afc4369f2149dc374f8c7f6d31cc65f35}\index{PAdmin@{PAdmin}!getInstrument@{getInstrument}}
|
|
\index{getInstrument@{getInstrument}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getInstrument()}{getInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_afc4369f2149dc374f8c7f6d31cc65f35}
|
|
\mbox{\hyperlink{classPInstrument}{PInstrument}} \texorpdfstring{$\ast$}{*} PAdmin\+::get\+Instrument (\begin{DoxyParamCaption}\item[{QString}]{institute}{, }\item[{QString}]{instrument}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a pointer to an instrument object.
|
|
|
|
\doxylink{classPAdmin_afc4369f2149dc374f8c7f6d31cc65f35}{PAdmin\+::get\+Instrument} returns a pointer to an instrument object.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em institute} & Institute name. \\
|
|
\hline
|
|
{\em instrument} & Instrument name. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPInstrument}{PInstrument}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
Searches for the specified institute and instrument combination.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em institute} & Institute name (e.\+g., "{}\+PSI"{}). \\
|
|
\hline
|
|
{\em instrument} & Instrument name (e.\+g., "{}\+HAL9500"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to the \doxylink{classPInstrument}{PInstrument} object, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_abab05fd73a15a3d602b7c09321f3bca6}\index{PAdmin@{PAdmin}!getInstrumentList@{getInstrumentList}}
|
|
\index{getInstrumentList@{getInstrumentList}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getInstrumentList()}{getInstrumentList()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_abab05fd73a15a3d602b7c09321f3bca6}
|
|
QString\+List PAdmin\+::get\+Instrument\+List (\begin{DoxyParamCaption}\item[{QString}]{institute}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a list of instruments for a given institute.
|
|
|
|
\doxylink{classPAdmin_abab05fd73a15a3d602b7c09321f3bca6}{PAdmin\+::get\+Instrument\+List} returns a list of instruments for a given institute.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em institute} & Institute name to query. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
QString\+List containing all instrument names for the institute.
|
|
\end{DoxyReturn}
|
|
Searches for the specified institute and returns the names of all instruments associated with it.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em institute} & Institute name to query (e.\+g., "{}\+PSI"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
QString\+List containing instrument names, or empty list if institute not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a0e6296de6e1994afb419c36d0864122e}\index{PAdmin@{PAdmin}!getMusrfitFunc@{getMusrfitFunc}}
|
|
\index{getMusrfitFunc@{getMusrfitFunc}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getMusrfitFunc()}{getMusrfitFunc()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a0e6296de6e1994afb419c36d0864122e}
|
|
QVector$<$ \mbox{\hyperlink{classPMusrfitFunc}{PMusrfit\+Func}} $>$ PAdmin\+::get\+Musrfit\+Func (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns all musrfit functions.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
QVector containing all \doxylink{classPMusrfitFunc}{PMusrfit\+Func} objects.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a92a8881fc004f7c50b261f9af795169e}\index{PAdmin@{PAdmin}!getMusrfitFunc@{getMusrfitFunc}}
|
|
\index{getMusrfitFunc@{getMusrfitFunc}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getMusrfitFunc()}{getMusrfitFunc()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a92a8881fc004f7c50b261f9af795169e}
|
|
\mbox{\hyperlink{classPMusrfitFunc}{PMusrfit\+Func}} PAdmin\+::get\+Musrfit\+Func (\begin{DoxyParamCaption}\item[{QString}]{name}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a musrfit function by name or abbreviation.
|
|
|
|
\doxylink{classPAdmin_a0e6296de6e1994afb419c36d0864122e}{PAdmin\+::get\+Musrfit\+Func} returns a musrfit function by name or abbreviation.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Function name or abbreviation. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
\doxylink{classPMusrfitFunc}{PMusrfit\+Func} matching the name, or default func if not found.
|
|
\end{DoxyReturn}
|
|
Searches the list of loaded musrfit functions for one matching the given name (either full name or abbreviation).
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Function name (e.\+g., "{}simple\+Gss"{}) or abbreviation (e.\+g., "{}sg"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
\doxylink{classPMusrfitFunc}{PMusrfit\+Func} matching the name, or a default/empty function if not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_aac48723474479dd8bf8f6cb8c88523e4}\index{PAdmin@{PAdmin}!getMusrfitFuncSize@{getMusrfitFuncSize}}
|
|
\index{getMusrfitFuncSize@{getMusrfitFuncSize}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getMusrfitFuncSize()}{getMusrfitFuncSize()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_aac48723474479dd8bf8f6cb8c88523e4}
|
|
int PAdmin\+::get\+Musrfit\+Func\+Size (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the number of musrfit functions.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Number of musrfit functions.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a0e56beee97bf8b692f75dde09b0439f3}\index{PAdmin@{PAdmin}!getTheoTemplate@{getTheoTemplate}}
|
|
\index{getTheoTemplate@{getTheoTemplate}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getTheoTemplate()}{getTheoTemplate()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a0e56beee97bf8b692f75dde09b0439f3}
|
|
\mbox{\hyperlink{classPTheoTemplate}{PTheo\+Template}} PAdmin\+::get\+Theo\+Template (\begin{DoxyParamCaption}\item[{int}]{idx}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a theory template by index.
|
|
|
|
\doxylink{classPAdmin_a0e56beee97bf8b692f75dde09b0439f3}{PAdmin\+::get\+Theo\+Template} returns a theory template by index.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em idx} & Index of the template. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
\doxylink{classPTheoTemplate}{PTheo\+Template} at the given index, or empty template if out of range.
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em idx} & Index of the requested theory template. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
\doxylink{classPTheoTemplate}{PTheo\+Template} at the given index, or an empty/default template if index is out of range.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_af29f6624a5d15de8c4f2254679b4bd87}\index{PAdmin@{PAdmin}!getTheoTemplates@{getTheoTemplates}}
|
|
\index{getTheoTemplates@{getTheoTemplates}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getTheoTemplates()}{getTheoTemplates()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_af29f6624a5d15de8c4f2254679b4bd87}
|
|
QVector$<$ \mbox{\hyperlink{classPTheoTemplate}{PTheo\+Template}} $>$ PAdmin\+::get\+Theo\+Templates (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns all theory templates.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
QVector containing all \doxylink{classPTheoTemplate}{PTheo\+Template} objects.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a037ef69fa93c00d62ed6bb79c7598695}\index{PAdmin@{PAdmin}!getTheoTemplateSize@{getTheoTemplateSize}}
|
|
\index{getTheoTemplateSize@{getTheoTemplateSize}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{getTheoTemplateSize()}{getTheoTemplateSize()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a037ef69fa93c00d62ed6bb79c7598695}
|
|
int PAdmin\+::get\+Theo\+Template\+Size (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the number of theory templates.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Number of theory templates.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_aaad5594e8308f0d6ff3e1c3526c2e8cb}\index{PAdmin@{PAdmin}!IsValid@{IsValid}}
|
|
\index{IsValid@{IsValid}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{IsValid()}{IsValid()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_aaad5594e8308f0d6ff3e1c3526c2e8cb}
|
|
bool PAdmin\+::\+Is\+Valid (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Checks if the admin object was initialized successfully.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
true if all required configuration files were loaded, false otherwise.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a7ae5802442b73cf5b01592c31f141637}\index{PAdmin@{PAdmin}!loadInstrumentDef@{loadInstrumentDef}}
|
|
\index{loadInstrumentDef@{loadInstrumentDef}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{loadInstrumentDef()}{loadInstrumentDef()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a7ae5802442b73cf5b01592c31f141637}
|
|
int PAdmin\+::load\+Instrument\+Def (\begin{DoxyParamCaption}\item[{QString}]{path}{, }\item[{QString}]{fln}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
Loads an instrument definition XML file.
|
|
|
|
\doxylink{classPAdmin_a7ae5802442b73cf5b01592c31f141637}{PAdmin\+::load\+Instrument\+Def} loads an instrument definition XML file.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em path} & Directory path containing the file. \\
|
|
\hline
|
|
{\em fln} & Filename of the instrument definition file. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on failure.
|
|
\end{DoxyReturn}
|
|
If the file doesn\textquotesingle{}t exist at the specified path, copies the default from the built-\/in Qt resource system to \$\+HOME/.musrfit/musr\+Wiz/.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em path} & Directory path containing the file. \\
|
|
\hline
|
|
{\em fln} & Filename of the instrument definition file (e.\+g., "{}instrument\+\_\+def\+\_\+psi.\+xml"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on failure.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_ab9bfe3e58e4c460fe5a977313ad1c8dd}\index{PAdmin@{PAdmin}!loadMusrfitFunc@{loadMusrfitFunc}}
|
|
\index{loadMusrfitFunc@{loadMusrfitFunc}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{loadMusrfitFunc()}{loadMusrfitFunc()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_ab9bfe3e58e4c460fe5a977313ad1c8dd}
|
|
int PAdmin\+::load\+Musrfit\+Func (\begin{DoxyParamCaption}\item[{QString}]{fln}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
Loads the musrfit\+\_\+funcs.\+xml file.
|
|
|
|
\doxylink{classPAdmin_ab9bfe3e58e4c460fe5a977313ad1c8dd}{PAdmin\+::load\+Musrfit\+Func} loads the musrfit\+\_\+funcs.\+xml file.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em fln} & Path to the file. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on failure.
|
|
\end{DoxyReturn}
|
|
If the file doesn\textquotesingle{}t exist at the specified path, copies the default from the built-\/in Qt resource system to \$\+HOME/.musrfit/musr\+Wiz/.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em fln} & Path to the musrfit\+\_\+funcs.\+xml file. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on failure.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPAdmin_a8349feaf916f9efdb5c1263f19d5b7a0}\index{PAdmin@{PAdmin}!loadMusrWizDefault@{loadMusrWizDefault}}
|
|
\index{loadMusrWizDefault@{loadMusrWizDefault}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{loadMusrWizDefault()}{loadMusrWizDefault()}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a8349feaf916f9efdb5c1263f19d5b7a0}
|
|
int PAdmin\+::load\+Musr\+Wiz\+Default (\begin{DoxyParamCaption}\item[{QString}]{fln}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
Loads the musr\+Wiz.\+xml default settings file.
|
|
|
|
\doxylink{classPAdmin_a8349feaf916f9efdb5c1263f19d5b7a0}{PAdmin\+::load\+Musr\+Wiz\+Default} loads the musr\+Wiz.\+xml default settings file.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em fln} & Path to the file. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on failure.
|
|
\end{DoxyReturn}
|
|
If the file doesn\textquotesingle{}t exist at the specified path, copies the default from the built-\/in Qt resource system to \$\+HOME/.musrfit/musr\+Wiz/.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em fln} & Path to the musr\+Wiz.\+xml file. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on failure.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
\doxysubsection{Friends And Related Symbol Documentation}
|
|
\Hypertarget{classPAdmin_a09464be8302897327f9ea74b90e55b7f}\index{PAdmin@{PAdmin}!PFuncXMLParser@{PFuncXMLParser}}
|
|
\index{PFuncXMLParser@{PFuncXMLParser}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{PFuncXMLParser}{PFuncXMLParser}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a09464be8302897327f9ea74b90e55b7f}
|
|
friend class \mbox{\hyperlink{classPFuncXMLParser}{PFunc\+XMLParser}}\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\Hypertarget{classPAdmin_a27cac88a70cf6e149c6544ff3ef4d73d}\index{PAdmin@{PAdmin}!PInstrumentDefXMLParser@{PInstrumentDefXMLParser}}
|
|
\index{PInstrumentDefXMLParser@{PInstrumentDefXMLParser}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{PInstrumentDefXMLParser}{PInstrumentDefXMLParser}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a27cac88a70cf6e149c6544ff3ef4d73d}
|
|
friend class \mbox{\hyperlink{classPInstrumentDefXMLParser}{PInstrument\+Def\+XMLParser}}\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
\Hypertarget{classPAdmin_af1be044375687ef9b270f2ae4a075289}\index{PAdmin@{PAdmin}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
|
|
\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{PMusrWizDefaultXMLParser}{PMusrWizDefaultXMLParser}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_af1be044375687ef9b270f2ae4a075289}
|
|
friend class \mbox{\hyperlink{classPMusrWizDefaultXMLParser}{PMusr\+Wiz\+Default\+XMLParser}}\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{classPAdmin_a3527c85b4a575d5bd3adb0396275dd90}\index{PAdmin@{PAdmin}!fDefault@{fDefault}}
|
|
\index{fDefault@{fDefault}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{fDefault}{fDefault}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a3527c85b4a575d5bd3adb0396275dd90}
|
|
\mbox{\hyperlink{classPMusrWizDefault}{PMusr\+Wiz\+Default}} PAdmin\+::f\+Default\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
default wizard settings
|
|
|
|
\Hypertarget{classPAdmin_a6dd0a70a12002db8b232e783f3ea072d}\index{PAdmin@{PAdmin}!fInstitute@{fInstitute}}
|
|
\index{fInstitute@{fInstitute}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{fInstitute}{fInstitute}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a6dd0a70a12002db8b232e783f3ea072d}
|
|
QVector$<$\mbox{\hyperlink{classPInstitute}{PInstitute}}$>$ PAdmin\+::f\+Institute\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
list of institutes with their instruments
|
|
|
|
\Hypertarget{classPAdmin_acd01fdc4c16e0e22ddebe523a37b3f12}\index{PAdmin@{PAdmin}!fMusrfitFunc@{fMusrfitFunc}}
|
|
\index{fMusrfitFunc@{fMusrfitFunc}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{fMusrfitFunc}{fMusrfitFunc}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_acd01fdc4c16e0e22ddebe523a37b3f12}
|
|
QVector$<$\mbox{\hyperlink{classPMusrfitFunc}{PMusrfit\+Func}}$>$ PAdmin\+::f\+Musrfit\+Func\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
list of musrfit functions
|
|
|
|
\Hypertarget{classPAdmin_ac3e9c2b6d3d893515cce7e71bbc140fc}\index{PAdmin@{PAdmin}!fTheoTemplate@{fTheoTemplate}}
|
|
\index{fTheoTemplate@{fTheoTemplate}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{fTheoTemplate}{fTheoTemplate}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_ac3e9c2b6d3d893515cce7e71bbc140fc}
|
|
QVector$<$\mbox{\hyperlink{classPTheoTemplate}{PTheo\+Template}}$>$ PAdmin\+::f\+Theo\+Template\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
list of theory templates
|
|
|
|
\Hypertarget{classPAdmin_a2584c56be1b93c48494fa0defd054c8d}\index{PAdmin@{PAdmin}!fValid@{fValid}}
|
|
\index{fValid@{fValid}!PAdmin@{PAdmin}}
|
|
\doxysubsubsection{\texorpdfstring{fValid}{fValid}}
|
|
{\footnotesize\ttfamily \label{classPAdmin_a2584c56be1b93c48494fa0defd054c8d}
|
|
bool PAdmin\+::f\+Valid\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
flag indicating successful initialization
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PAdmin_8h}{PAdmin.\+h}}\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PAdmin_8cpp}{PAdmin.\+cpp}}\end{DoxyCompactItemize}
|