504 lines
25 KiB
TeX
504 lines
25 KiB
TeX
\doxysection{PInstrument Class Reference}
|
|
\hypertarget{classPInstrument}{}\label{classPInstrument}\index{PInstrument@{PInstrument}}
|
|
|
|
|
|
The \doxylink{classPInstrument}{PInstrument} class represents a muon spectrometer instrument.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$PInstrument\+Def.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classPInstrument_a3a877e8f460bca446ecb54f9160b7b22}{PInstrument}} ()
|
|
\begin{DoxyCompactList}\small\item\em Constructor. Initializes all strings to empty. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPInstrument_a94e1b0d01e0d8f55da906352dbab5500}{\texorpdfstring{$\sim$}{\string~}\+PInstrument}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a344dc2d989d7b10127288ab5f2d67357}{set\+Run\+Name\+Template}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the run name template for data file naming. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_afcfda548e52408023eb45c1da5dd46f0}{set\+Beamline}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the beamline name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a6dfeac6ed434803191a2673e84570acb}{set\+Data\+File\+Format}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the data file format. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a22263a621c0ac36cece5bbd28504ba91}{set\+Institue}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the institute name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a1243d91f256e7d9a0e61d9c0dbe21aef}{set\+Name}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the instrument name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a4706311b19620eb2fcd6dda3822d4549}{add\+Setup\+ZF}} (\mbox{\hyperlink{classPSetup}{PSetup}} zf)
|
|
\begin{DoxyCompactList}\small\item\em Adds a zero-\/field (ZF) setup configuration. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a2bf1014c30a55b5cd62da9bc009fc7d0}{add\+Setup\+TF}} (\mbox{\hyperlink{classPSetup}{PSetup}} tf)
|
|
\begin{DoxyCompactList}\small\item\em Adds a transverse-\/field (TF) setup configuration. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPInstrument_a083a6ed5c1112e31307427fe351cd858}{add\+Setup\+LF}} (\mbox{\hyperlink{classPSetup}{PSetup}} lf)
|
|
\begin{DoxyCompactList}\small\item\em Adds a longitudinal-\/field (LF) setup configuration. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a89083e236ba179b7d2f4931aa707598f}{get\+Run\+Name\+Template}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the run name template. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a776743536e3887e4673cb929adc9a3ea}{get\+Beamline}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the beamline name. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a949d3e21f595a0f03dbdfc38623d4531}{get\+Data\+File\+Format}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the data file format. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_ab6b3f7f469486cb9b7b3317b11c4ca33}{get\+Institute}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the institute name. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a84d77be98ff821cfc44c83068fa07a88}{get\+Name}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the instrument name. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ \mbox{\hyperlink{classPInstrument_afbbefc4d205dbd5fc9bba4ac4107e4db}{get\+ZFSetups}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns all ZF setups. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ \mbox{\hyperlink{classPInstrument_ac863bc561daedf9dd0ca71ce1b741aa4}{get\+TFSetups}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns all TF setups. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ \mbox{\hyperlink{classPInstrument_a01b0527ae770dc61d1c4d5b9be54dee7}{get\+LFSetups}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns all LF setups. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPSetup}{PSetup}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPInstrument_a7f691b4ec1f17a3ca6d32c1a6f07c056}{get\+ZFSetup}} (QString name="{}"{})
|
|
\begin{DoxyCompactList}\small\item\em Returns a ZF setup by name. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPSetup}{PSetup}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPInstrument_a0ad2349eb80825c296bea9978d5ebd20}{get\+TFSetup}} (QString name="{}"{})
|
|
\begin{DoxyCompactList}\small\item\em Returns a TF setup by name. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPSetup}{PSetup}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPInstrument_a32892770ad2c75a9d5004f98a8728eb8}{get\+LFSetup}} (QString name="{}"{})
|
|
\begin{DoxyCompactList}\small\item\em Returns a LF setup by name. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
QString \mbox{\hyperlink{classPInstrument_a9f7d7748c4a378386628745a43d0f59e}{f\+Run\+Name\+Template}}
|
|
\begin{DoxyCompactList}\small\item\em template for run file names \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a8befe2ae4c5c06d2c57c7c47e36d3117}{f\+Beamline}}
|
|
\begin{DoxyCompactList}\small\item\em beamline identifier \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a7705bfd8f45990c9b743a575e27374b5}{f\+Data\+File\+Format}}
|
|
\begin{DoxyCompactList}\small\item\em data file format \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a15d17c130e003bf926c24d1412ad5bdb}{f\+Institue}}
|
|
\begin{DoxyCompactList}\small\item\em institute name \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPInstrument_a86fe143e7d738394f921a2b786a6a766}{f\+Name}}
|
|
\begin{DoxyCompactList}\small\item\em instrument name \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ \mbox{\hyperlink{classPInstrument_ab8b474e34e85ad25132af5a88135830a}{f\+ZF}}
|
|
\begin{DoxyCompactList}\small\item\em zero-\/field setups \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ \mbox{\hyperlink{classPInstrument_ac5f89590814c0b30139e7db8d5113847}{f\+TF}}
|
|
\begin{DoxyCompactList}\small\item\em transverse-\/field setups \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ \mbox{\hyperlink{classPInstrument_ae9c7937400cf10d0d45709321119d509}{f\+LF}}
|
|
\begin{DoxyCompactList}\small\item\em longitudinal-\/field setups \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
The \doxylink{classPInstrument}{PInstrument} class represents a muon spectrometer instrument.
|
|
|
|
This class contains all information about a specific muon instrument including its name, beamline, run name template, data file format, and measurement setups for ZF (zero field), TF (transverse field), and LF (longitudinal field) configurations.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classPInstrument_a3a877e8f460bca446ecb54f9160b7b22}\index{PInstrument@{PInstrument}!PInstrument@{PInstrument}}
|
|
\index{PInstrument@{PInstrument}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{PInstrument()}{PInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a3a877e8f460bca446ecb54f9160b7b22}
|
|
PInstrument\+::\+PInstrument (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Constructor. Initializes all strings to empty.
|
|
|
|
\doxylink{classPInstrument_a3a877e8f460bca446ecb54f9160b7b22}{PInstrument\+::\+PInstrument} constructor initializes all strings to empty. \Hypertarget{classPInstrument_a94e1b0d01e0d8f55da906352dbab5500}\index{PInstrument@{PInstrument}!````~PInstrument@{\texorpdfstring{$\sim$}{\string~}PInstrument}}
|
|
\index{````~PInstrument@{\texorpdfstring{$\sim$}{\string~}PInstrument}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PInstrument()}{\string~PInstrument()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a94e1b0d01e0d8f55da906352dbab5500}
|
|
PInstrument\+::\texorpdfstring{$\sim$}{\string~}\+PInstrument (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{classPInstrument_a083a6ed5c1112e31307427fe351cd858}\index{PInstrument@{PInstrument}!addSetupLF@{addSetupLF}}
|
|
\index{addSetupLF@{addSetupLF}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{addSetupLF()}{addSetupLF()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a083a6ed5c1112e31307427fe351cd858}
|
|
void PInstrument\+::add\+Setup\+LF (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classPSetup}{PSetup}}}]{lf}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Adds a longitudinal-\/field (LF) setup configuration.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em lf} & Setup object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a2bf1014c30a55b5cd62da9bc009fc7d0}\index{PInstrument@{PInstrument}!addSetupTF@{addSetupTF}}
|
|
\index{addSetupTF@{addSetupTF}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{addSetupTF()}{addSetupTF()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a2bf1014c30a55b5cd62da9bc009fc7d0}
|
|
void PInstrument\+::add\+Setup\+TF (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classPSetup}{PSetup}}}]{tf}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Adds a transverse-\/field (TF) setup configuration.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em tf} & Setup object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a4706311b19620eb2fcd6dda3822d4549}\index{PInstrument@{PInstrument}!addSetupZF@{addSetupZF}}
|
|
\index{addSetupZF@{addSetupZF}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{addSetupZF()}{addSetupZF()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a4706311b19620eb2fcd6dda3822d4549}
|
|
void PInstrument\+::add\+Setup\+ZF (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classPSetup}{PSetup}}}]{zf}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Adds a zero-\/field (ZF) setup configuration.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em zf} & Setup object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a776743536e3887e4673cb929adc9a3ea}\index{PInstrument@{PInstrument}!getBeamline@{getBeamline}}
|
|
\index{getBeamline@{getBeamline}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getBeamline()}{getBeamline()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a776743536e3887e4673cb929adc9a3ea}
|
|
QString PInstrument\+::get\+Beamline (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the beamline name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Beamline name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a949d3e21f595a0f03dbdfc38623d4531}\index{PInstrument@{PInstrument}!getDataFileFormat@{getDataFileFormat}}
|
|
\index{getDataFileFormat@{getDataFileFormat}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getDataFileFormat()}{getDataFileFormat()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a949d3e21f595a0f03dbdfc38623d4531}
|
|
QString PInstrument\+::get\+Data\+File\+Format (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the data file format.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Data file format string.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_ab6b3f7f469486cb9b7b3317b11c4ca33}\index{PInstrument@{PInstrument}!getInstitute@{getInstitute}}
|
|
\index{getInstitute@{getInstitute}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getInstitute()}{getInstitute()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_ab6b3f7f469486cb9b7b3317b11c4ca33}
|
|
QString PInstrument\+::get\+Institute (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the institute name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Institute name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a32892770ad2c75a9d5004f98a8728eb8}\index{PInstrument@{PInstrument}!getLFSetup@{getLFSetup}}
|
|
\index{getLFSetup@{getLFSetup}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getLFSetup()}{getLFSetup()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a32892770ad2c75a9d5004f98a8728eb8}
|
|
\mbox{\hyperlink{classPSetup}{PSetup}} \texorpdfstring{$\ast$}{*} PInstrument\+::get\+LFSetup (\begin{DoxyParamCaption}\item[{QString}]{name}{ = {\ttfamily "{}"{}}}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a LF setup by name.
|
|
|
|
\doxylink{classPInstrument_a32892770ad2c75a9d5004f98a8728eb8}{PInstrument\+::get\+LFSetup} returns a longitudinal-\/field setup by name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Setup name (default\+: first available). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPSetup}{PSetup}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Setup name to search for. If empty, returns the first available setup. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPSetup}{PSetup}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a01b0527ae770dc61d1c4d5b9be54dee7}\index{PInstrument@{PInstrument}!getLFSetups@{getLFSetups}}
|
|
\index{getLFSetups@{getLFSetups}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getLFSetups()}{getLFSetups()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a01b0527ae770dc61d1c4d5b9be54dee7}
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ PInstrument\+::get\+LFSetups (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns all LF setups.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Vector of LF setup configurations.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a84d77be98ff821cfc44c83068fa07a88}\index{PInstrument@{PInstrument}!getName@{getName}}
|
|
\index{getName@{getName}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a84d77be98ff821cfc44c83068fa07a88}
|
|
QString PInstrument\+::get\+Name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the instrument name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Instrument name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a89083e236ba179b7d2f4931aa707598f}\index{PInstrument@{PInstrument}!getRunNameTemplate@{getRunNameTemplate}}
|
|
\index{getRunNameTemplate@{getRunNameTemplate}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getRunNameTemplate()}{getRunNameTemplate()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a89083e236ba179b7d2f4931aa707598f}
|
|
QString PInstrument\+::get\+Run\+Name\+Template (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the run name template.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Run name template string.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a0ad2349eb80825c296bea9978d5ebd20}\index{PInstrument@{PInstrument}!getTFSetup@{getTFSetup}}
|
|
\index{getTFSetup@{getTFSetup}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getTFSetup()}{getTFSetup()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a0ad2349eb80825c296bea9978d5ebd20}
|
|
\mbox{\hyperlink{classPSetup}{PSetup}} \texorpdfstring{$\ast$}{*} PInstrument\+::get\+TFSetup (\begin{DoxyParamCaption}\item[{QString}]{name}{ = {\ttfamily "{}"{}}}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a TF setup by name.
|
|
|
|
\doxylink{classPInstrument_a0ad2349eb80825c296bea9978d5ebd20}{PInstrument\+::get\+TFSetup} returns a transverse-\/field setup by name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Setup name (default\+: first available). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPSetup}{PSetup}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Setup name to search for. If empty, returns the first available setup. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPSetup}{PSetup}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_ac863bc561daedf9dd0ca71ce1b741aa4}\index{PInstrument@{PInstrument}!getTFSetups@{getTFSetups}}
|
|
\index{getTFSetups@{getTFSetups}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getTFSetups()}{getTFSetups()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_ac863bc561daedf9dd0ca71ce1b741aa4}
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ PInstrument\+::get\+TFSetups (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns all TF setups.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Vector of TF setup configurations.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_a7f691b4ec1f17a3ca6d32c1a6f07c056}\index{PInstrument@{PInstrument}!getZFSetup@{getZFSetup}}
|
|
\index{getZFSetup@{getZFSetup}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getZFSetup()}{getZFSetup()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a7f691b4ec1f17a3ca6d32c1a6f07c056}
|
|
\mbox{\hyperlink{classPSetup}{PSetup}} \texorpdfstring{$\ast$}{*} PInstrument\+::get\+ZFSetup (\begin{DoxyParamCaption}\item[{QString}]{name}{ = {\ttfamily "{}"{}}}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a ZF setup by name.
|
|
|
|
\doxylink{classPInstrument_a7f691b4ec1f17a3ca6d32c1a6f07c056}{PInstrument\+::get\+ZFSetup} returns a zero-\/field setup by name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Setup name (default\+: first available). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPSetup}{PSetup}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Setup name to search for. If empty, returns the first available setup. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to \doxylink{classPSetup}{PSetup}, or nullptr if not found.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_afbbefc4d205dbd5fc9bba4ac4107e4db}\index{PInstrument@{PInstrument}!getZFSetups@{getZFSetups}}
|
|
\index{getZFSetups@{getZFSetups}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{getZFSetups()}{getZFSetups()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_afbbefc4d205dbd5fc9bba4ac4107e4db}
|
|
QVector$<$ \mbox{\hyperlink{classPSetup}{PSetup}} $>$ PInstrument\+::get\+ZFSetups (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns all ZF setups.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Vector of ZF setup configurations.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPInstrument_afcfda548e52408023eb45c1da5dd46f0}\index{PInstrument@{PInstrument}!setBeamline@{setBeamline}}
|
|
\index{setBeamline@{setBeamline}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{setBeamline()}{setBeamline()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_afcfda548e52408023eb45c1da5dd46f0}
|
|
void PInstrument\+::set\+Beamline (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the beamline name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em str} & Beamline identifier (e.\+g., "{}pi\+M3.\+2"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a6dfeac6ed434803191a2673e84570acb}\index{PInstrument@{PInstrument}!setDataFileFormat@{setDataFileFormat}}
|
|
\index{setDataFileFormat@{setDataFileFormat}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{setDataFileFormat()}{setDataFileFormat()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a6dfeac6ed434803191a2673e84570acb}
|
|
void PInstrument\+::set\+Data\+File\+Format (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the data file format.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em str} & File format (e.\+g., "{}\+Psi\+Mdu"{}, "{}\+Ne\+Xus"{}, "{}\+WKM"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a22263a621c0ac36cece5bbd28504ba91}\index{PInstrument@{PInstrument}!setInstitue@{setInstitue}}
|
|
\index{setInstitue@{setInstitue}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{setInstitue()}{setInstitue()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a22263a621c0ac36cece5bbd28504ba91}
|
|
void PInstrument\+::set\+Institue (\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"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a1243d91f256e7d9a0e61d9c0dbe21aef}\index{PInstrument@{PInstrument}!setName@{setName}}
|
|
\index{setName@{setName}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{setName()}{setName()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a1243d91f256e7d9a0e61d9c0dbe21aef}
|
|
void PInstrument\+::set\+Name (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the instrument name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em str} & Instrument name (e.\+g., "{}\+GPS"{}, "{}\+HAL9500"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPInstrument_a344dc2d989d7b10127288ab5f2d67357}\index{PInstrument@{PInstrument}!setRunNameTemplate@{setRunNameTemplate}}
|
|
\index{setRunNameTemplate@{setRunNameTemplate}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{setRunNameTemplate()}{setRunNameTemplate()}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a344dc2d989d7b10127288ab5f2d67357}
|
|
void PInstrument\+::set\+Run\+Name\+Template (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the run name template for data file naming.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em str} & Template string (e.\+g., "{}deltat\+\_\+tdc\+\_\+gps\+\_\+\mbox{[}yyyy\mbox{]}\+\_\+\mbox{[}nnnn\mbox{]}.\+bin"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{classPInstrument_a8befe2ae4c5c06d2c57c7c47e36d3117}\index{PInstrument@{PInstrument}!fBeamline@{fBeamline}}
|
|
\index{fBeamline@{fBeamline}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fBeamline}{fBeamline}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a8befe2ae4c5c06d2c57c7c47e36d3117}
|
|
QString PInstrument\+::f\+Beamline\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
beamline identifier
|
|
|
|
\Hypertarget{classPInstrument_a7705bfd8f45990c9b743a575e27374b5}\index{PInstrument@{PInstrument}!fDataFileFormat@{fDataFileFormat}}
|
|
\index{fDataFileFormat@{fDataFileFormat}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fDataFileFormat}{fDataFileFormat}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a7705bfd8f45990c9b743a575e27374b5}
|
|
QString PInstrument\+::f\+Data\+File\+Format\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
data file format
|
|
|
|
\Hypertarget{classPInstrument_a15d17c130e003bf926c24d1412ad5bdb}\index{PInstrument@{PInstrument}!fInstitue@{fInstitue}}
|
|
\index{fInstitue@{fInstitue}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fInstitue}{fInstitue}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a15d17c130e003bf926c24d1412ad5bdb}
|
|
QString PInstrument\+::f\+Institue\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
institute name
|
|
|
|
\Hypertarget{classPInstrument_ae9c7937400cf10d0d45709321119d509}\index{PInstrument@{PInstrument}!fLF@{fLF}}
|
|
\index{fLF@{fLF}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fLF}{fLF}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_ae9c7937400cf10d0d45709321119d509}
|
|
QVector$<$\mbox{\hyperlink{classPSetup}{PSetup}}$>$ PInstrument\+::f\+LF\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
longitudinal-\/field setups
|
|
|
|
\Hypertarget{classPInstrument_a86fe143e7d738394f921a2b786a6a766}\index{PInstrument@{PInstrument}!fName@{fName}}
|
|
\index{fName@{fName}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fName}{fName}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a86fe143e7d738394f921a2b786a6a766}
|
|
QString PInstrument\+::f\+Name\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
instrument name
|
|
|
|
\Hypertarget{classPInstrument_a9f7d7748c4a378386628745a43d0f59e}\index{PInstrument@{PInstrument}!fRunNameTemplate@{fRunNameTemplate}}
|
|
\index{fRunNameTemplate@{fRunNameTemplate}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fRunNameTemplate}{fRunNameTemplate}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_a9f7d7748c4a378386628745a43d0f59e}
|
|
QString PInstrument\+::f\+Run\+Name\+Template\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
template for run file names
|
|
|
|
\Hypertarget{classPInstrument_ac5f89590814c0b30139e7db8d5113847}\index{PInstrument@{PInstrument}!fTF@{fTF}}
|
|
\index{fTF@{fTF}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fTF}{fTF}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_ac5f89590814c0b30139e7db8d5113847}
|
|
QVector$<$\mbox{\hyperlink{classPSetup}{PSetup}}$>$ PInstrument\+::f\+TF\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
transverse-\/field setups
|
|
|
|
\Hypertarget{classPInstrument_ab8b474e34e85ad25132af5a88135830a}\index{PInstrument@{PInstrument}!fZF@{fZF}}
|
|
\index{fZF@{fZF}!PInstrument@{PInstrument}}
|
|
\doxysubsubsection{\texorpdfstring{fZF}{fZF}}
|
|
{\footnotesize\ttfamily \label{classPInstrument_ab8b474e34e85ad25132af5a88135830a}
|
|
QVector$<$\mbox{\hyperlink{classPSetup}{PSetup}}$>$ PInstrument\+::f\+ZF\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
zero-\/field setups
|
|
|
|
|
|
|
|
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}
|