180 lines
8.7 KiB
TeX
180 lines
8.7 KiB
TeX
\doxysection{PInstitute Class Reference}
|
|
\hypertarget{classPInstitute}{}\label{classPInstitute}\index{PInstitute@{PInstitute}}
|
|
|
|
|
|
The \doxylink{classPInstitute}{PInstitute} class represents a muon research facility/institute.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$PInstrument\+Def.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classPInstitute_a5f430169f414f8ef012afa3511c0c201}{PInstitute}} ()
|
|
\begin{DoxyCompactList}\small\item\em Constructor. Initializes the name to empty. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPInstitute_a62fd02658cf321aa9e1fcd8807fc544f}{\texorpdfstring{$\sim$}{\string~}\+PInstitute}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstitute_a4cea2683bfcb935b572c94eb295c828a}{set\+Name}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the institute name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstitute_aba9ebb12e1704c46ac42c3264dc79970}{add\+Instrument}} (\mbox{\hyperlink{classPInstrument}{PInstrument}} instrument)
|
|
\begin{DoxyCompactList}\small\item\em Adds an instrument to this institute. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstitute_a2f0a97fef6f3664b294c99a426f0906c}{get\+Name}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the institute name. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPInstrument}{PInstrument}} $>$ \mbox{\hyperlink{classPInstitute_a4ca6b92355afad094bd1636d406b0050}{get\+Instruments}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns all instruments belonging to this institute. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPInstrument}{PInstrument}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPInstitute_a394f17f0d77ef1a64fea031c87c48b11}{get\+Instrument}} (QString name)
|
|
\begin{DoxyCompactList}\small\item\em Returns an instrument by name. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
QString \mbox{\hyperlink{classPInstitute_afb38070555d55e16b4fe591ae7b1194e}{f\+Name}}
|
|
\begin{DoxyCompactList}\small\item\em institute name \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPInstrument}{PInstrument}} $>$ \mbox{\hyperlink{classPInstitute_a94521a60637907b668778b33d11790a0}{f\+Instrument}}
|
|
\begin{DoxyCompactList}\small\item\em list of instruments at this institute \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
The \doxylink{classPInstitute}{PInstitute} class represents a muon research facility/institute.
|
|
|
|
This class groups multiple muon instruments belonging to the same research facility (e.\+g., PSI, TRIUMF, ISIS, J-\/\+PARC).
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classPInstitute_a5f430169f414f8ef012afa3511c0c201}\index{PInstitute@{PInstitute}!PInstitute@{PInstitute}}
|
|
\index{PInstitute@{PInstitute}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{PInstitute()}{PInstitute()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a5f430169f414f8ef012afa3511c0c201}
|
|
PInstitute\+::\+PInstitute (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Constructor. Initializes the name to empty.
|
|
|
|
\doxylink{classPInstitute_a5f430169f414f8ef012afa3511c0c201}{PInstitute\+::\+PInstitute} constructor initializes the name to empty. \Hypertarget{classPInstitute_a62fd02658cf321aa9e1fcd8807fc544f}\index{PInstitute@{PInstitute}!````~PInstitute@{\texorpdfstring{$\sim$}{\string~}PInstitute}}
|
|
\index{````~PInstitute@{\texorpdfstring{$\sim$}{\string~}PInstitute}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PInstitute()}{\string~PInstitute()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a62fd02658cf321aa9e1fcd8807fc544f}
|
|
PInstitute\+::\texorpdfstring{$\sim$}{\string~}\+PInstitute (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{classPInstitute_aba9ebb12e1704c46ac42c3264dc79970}\index{PInstitute@{PInstitute}!addInstrument@{addInstrument}}
|
|
\index{addInstrument@{addInstrument}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{addInstrument()}{addInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_aba9ebb12e1704c46ac42c3264dc79970}
|
|
void PInstitute\+::add\+Instrument (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classPInstrument}{PInstrument}}}]{instrument}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Adds an instrument to this institute.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em instrument} & Instrument object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstitute_a394f17f0d77ef1a64fea031c87c48b11}\index{PInstitute@{PInstitute}!getInstrument@{getInstrument}}
|
|
\index{getInstrument@{getInstrument}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{getInstrument()}{getInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a394f17f0d77ef1a64fea031c87c48b11}
|
|
\mbox{\hyperlink{classPInstrument}{PInstrument}} \texorpdfstring{$\ast$}{*} PInstitute\+::get\+Instrument (\begin{DoxyParamCaption}\item[{QString}]{name}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns an instrument by name.
|
|
|
|
\doxylink{classPInstitute_a394f17f0d77ef1a64fea031c87c48b11}{PInstitute\+::get\+Instrument} returns an instrument by name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Instrument name. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPInstrument}{PInstrument}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Instrument name to search for. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPInstrument}{PInstrument}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstitute_a4ca6b92355afad094bd1636d406b0050}\index{PInstitute@{PInstitute}!getInstruments@{getInstruments}}
|
|
\index{getInstruments@{getInstruments}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{getInstruments()}{getInstruments()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a4ca6b92355afad094bd1636d406b0050}
|
|
QVector$<$ \mbox{\hyperlink{classPInstrument}{PInstrument}} $>$ PInstitute\+::get\+Instruments (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns all instruments belonging to this institute.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Vector of \doxylink{classPInstrument}{PInstrument} objects.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstitute_a2f0a97fef6f3664b294c99a426f0906c}\index{PInstitute@{PInstitute}!getName@{getName}}
|
|
\index{getName@{getName}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a2f0a97fef6f3664b294c99a426f0906c}
|
|
QString PInstitute\+::get\+Name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the institute name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Institute name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstitute_a4cea2683bfcb935b572c94eb295c828a}\index{PInstitute@{PInstitute}!setName@{setName}}
|
|
\index{setName@{setName}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{setName()}{setName()}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a4cea2683bfcb935b572c94eb295c828a}
|
|
void PInstitute\+::set\+Name (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the institute name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em str} & Institute name (e.\+g., "{}\+PSI"{}, "{}\+TRIUMF"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{classPInstitute_a94521a60637907b668778b33d11790a0}\index{PInstitute@{PInstitute}!fInstrument@{fInstrument}}
|
|
\index{fInstrument@{fInstrument}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{fInstrument}{fInstrument}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_a94521a60637907b668778b33d11790a0}
|
|
QVector$<$\mbox{\hyperlink{classPInstrument}{PInstrument}}$>$ PInstitute\+::f\+Instrument\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
list of instruments at this institute
|
|
|
|
\Hypertarget{classPInstitute_afb38070555d55e16b4fe591ae7b1194e}\index{PInstitute@{PInstitute}!fName@{fName}}
|
|
\index{fName@{fName}!PInstitute@{PInstitute}}
|
|
\doxysubsubsection{\texorpdfstring{fName}{fName}}
|
|
{\footnotesize\ttfamily \label{classPInstitute_afb38070555d55e16b4fe591ae7b1194e}
|
|
QString PInstitute\+::f\+Name\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
institute name
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PInstrumentDef_8h}{PInstrument\+Def.\+h}}\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PInstrumentDef_8cpp}{PInstrument\+Def.\+cpp}}\end{DoxyCompactItemize}
|