282 lines
14 KiB
TeX
282 lines
14 KiB
TeX
\doxysection{PMusrfit\+Func Class Reference}
|
|
\hypertarget{classPMusrfitFunc}{}\label{classPMusrfitFunc}\index{PMusrfitFunc@{PMusrfitFunc}}
|
|
|
|
|
|
The \doxylink{classPMusrfitFunc}{PMusrfit\+Func} class represents a musrfit theory function.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$PMusrfit\+Func.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classPMusrfitFunc_ab00e630e561945e3019317148a8e2485}{PMusrfit\+Func}} ()
|
|
\begin{DoxyCompactList}\small\item\em Constructor. Initializes to default values. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPMusrfitFunc_a499354d09ff9026c67ecf6d20e2e60ff}{\texorpdfstring{$\sim$}{\string~}\+PMusrfit\+Func}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPMusrfitFunc_a8afd07d0150c5aa19755033734376ef3}{init\+Func}} ()
|
|
\begin{DoxyCompactList}\small\item\em Initializes all member variables to default values. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPMusrfitFunc_aad99ca8a5ff53b5f85b78fc31b92a382}{set\+Name}} (QString name)
|
|
\begin{DoxyCompactList}\small\item\em Sets the function name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPMusrfitFunc_a562f707fc93568cbeb66f7f77d3ef9b3}{set\+Abbrv}} (QString abbrv)
|
|
\begin{DoxyCompactList}\small\item\em Sets the function abbreviation. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPMusrfitFunc_a20af00a7c649360f325948708491a1d6}{set\+No\+Of\+Param}} (int ival)
|
|
\begin{DoxyCompactList}\small\item\em Sets the number of parameters this function takes. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPMusrfitFunc_ad2eee349df465ca060ad622200953d3d}{add\+Func\+Param}} (\mbox{\hyperlink{classPFuncParam}{PFunc\+Param}} param)
|
|
\begin{DoxyCompactList}\small\item\em Adds a parameter definition to this function. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPMusrfitFunc_a75fc688262860880e61f987910a4af6c}{get\+Name}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the function name. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPMusrfitFunc_ac28ea80e13d0806b47029c73233e3886}{get\+Abbrv}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the function abbreviation. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classPMusrfitFunc_adc15a97ed5280e718944b6955afaabfc}{get\+No\+Of\+Param}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the number of parameters. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPFuncParam}{PFunc\+Param}} \mbox{\hyperlink{classPMusrfitFunc_a4e1824427b7401a73451f5f6c68ea3a5}{get\+Func\+Param}} (int idx)
|
|
\begin{DoxyCompactList}\small\item\em Returns a function parameter by index. \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPFuncParam}{PFunc\+Param}} $>$ \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPMusrfitFunc_a1fba2badb3bb48aedc160f6bd6dc2237}{get\+Func\+Params}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns a pointer to the parameter vector. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
QString \mbox{\hyperlink{classPMusrfitFunc_a0a925ddbaafaca6ec88fa2949518da33}{f\+Name}}
|
|
\begin{DoxyCompactList}\small\item\em full function name \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPMusrfitFunc_af51c07a9c3b381a4e4afd66f07c5afb0}{f\+Abbrv}}
|
|
\begin{DoxyCompactList}\small\item\em abbreviation for msr-\/files \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classPMusrfitFunc_ad84707dfe1a1b1e5aa46179109d483f6}{f\+No\+Of\+Param}}
|
|
\begin{DoxyCompactList}\small\item\em number of parameters \end{DoxyCompactList}\item
|
|
QVector$<$ \mbox{\hyperlink{classPFuncParam}{PFunc\+Param}} $>$ \mbox{\hyperlink{classPMusrfitFunc_a4aeae21bf9959ae68aaada0c42e11563}{f\+Param}}
|
|
\begin{DoxyCompactList}\small\item\em parameter definitions \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
The \doxylink{classPMusrfitFunc}{PMusrfit\+Func} class represents a musrfit theory function.
|
|
|
|
This class holds the definition of a musrfit theory function including its full name, abbreviation (used in msr-\/files), number of parameters, and the parameter definitions. Examples include simple\+Gss (sg), simple\+Lor (sl), TField\+Cos (tf), etc.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classPMusrfitFunc_ab00e630e561945e3019317148a8e2485}\index{PMusrfitFunc@{PMusrfitFunc}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\index{PMusrfitFunc@{PMusrfitFunc}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{PMusrfitFunc()}{PMusrfitFunc()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_ab00e630e561945e3019317148a8e2485}
|
|
PMusrfit\+Func\+::\+PMusrfit\+Func (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Constructor. Initializes to default values.
|
|
|
|
\Hypertarget{classPMusrfitFunc_a499354d09ff9026c67ecf6d20e2e60ff}\index{PMusrfitFunc@{PMusrfitFunc}!````~PMusrfitFunc@{\texorpdfstring{$\sim$}{\string~}PMusrfitFunc}}
|
|
\index{````~PMusrfitFunc@{\texorpdfstring{$\sim$}{\string~}PMusrfitFunc}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PMusrfitFunc()}{\string~PMusrfitFunc()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a499354d09ff9026c67ecf6d20e2e60ff}
|
|
PMusrfit\+Func\+::\texorpdfstring{$\sim$}{\string~}\+PMusrfit\+Func (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{classPMusrfitFunc_ad2eee349df465ca060ad622200953d3d}\index{PMusrfitFunc@{PMusrfitFunc}!addFuncParam@{addFuncParam}}
|
|
\index{addFuncParam@{addFuncParam}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{addFuncParam()}{addFuncParam()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_ad2eee349df465ca060ad622200953d3d}
|
|
void PMusrfit\+Func\+::add\+Func\+Param (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classPFuncParam}{PFunc\+Param}}}]{param}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Adds a parameter definition to this function.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em param} & Parameter object to add. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPMusrfitFunc_ac28ea80e13d0806b47029c73233e3886}\index{PMusrfitFunc@{PMusrfitFunc}!getAbbrv@{getAbbrv}}
|
|
\index{getAbbrv@{getAbbrv}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{getAbbrv()}{getAbbrv()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_ac28ea80e13d0806b47029c73233e3886}
|
|
QString PMusrfit\+Func\+::get\+Abbrv (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the function abbreviation.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Abbreviation string.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPMusrfitFunc_a4e1824427b7401a73451f5f6c68ea3a5}\index{PMusrfitFunc@{PMusrfitFunc}!getFuncParam@{getFuncParam}}
|
|
\index{getFuncParam@{getFuncParam}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{getFuncParam()}{getFuncParam()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a4e1824427b7401a73451f5f6c68ea3a5}
|
|
\mbox{\hyperlink{classPFuncParam}{PFunc\+Param}} PMusrfit\+Func\+::get\+Func\+Param (\begin{DoxyParamCaption}\item[{int}]{idx}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Returns a function parameter by index.
|
|
|
|
\doxylink{classPMusrfitFunc_a4e1824427b7401a73451f5f6c68ea3a5}{PMusrfit\+Func\+::get\+Func\+Param} returns a function parameter by index.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em idx} & Index of the parameter. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
\doxylink{classPFuncParam}{PFunc\+Param} at the given index, or default param if out of range.
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em idx} & Index of the parameter (0-\/based). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
\doxylink{classPFuncParam}{PFunc\+Param} at the given index, or an empty/default parameter if index is out of range.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPMusrfitFunc_a1fba2badb3bb48aedc160f6bd6dc2237}\index{PMusrfitFunc@{PMusrfitFunc}!getFuncParams@{getFuncParams}}
|
|
\index{getFuncParams@{getFuncParams}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{getFuncParams()}{getFuncParams()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a1fba2badb3bb48aedc160f6bd6dc2237}
|
|
QVector$<$ \mbox{\hyperlink{classPFuncParam}{PFunc\+Param}} $>$ \texorpdfstring{$\ast$}{*} PMusrfit\+Func\+::get\+Func\+Params (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns a pointer to the parameter vector.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Pointer to the QVector of \doxylink{classPFuncParam}{PFunc\+Param}.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPMusrfitFunc_a75fc688262860880e61f987910a4af6c}\index{PMusrfitFunc@{PMusrfitFunc}!getName@{getName}}
|
|
\index{getName@{getName}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a75fc688262860880e61f987910a4af6c}
|
|
QString PMusrfit\+Func\+::get\+Name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the function name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Full function name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPMusrfitFunc_adc15a97ed5280e718944b6955afaabfc}\index{PMusrfitFunc@{PMusrfitFunc}!getNoOfParam@{getNoOfParam}}
|
|
\index{getNoOfParam@{getNoOfParam}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{getNoOfParam()}{getNoOfParam()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_adc15a97ed5280e718944b6955afaabfc}
|
|
int PMusrfit\+Func\+::get\+No\+Of\+Param (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the number of parameters.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Number of parameters.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPMusrfitFunc_a8afd07d0150c5aa19755033734376ef3}\index{PMusrfitFunc@{PMusrfitFunc}!initFunc@{initFunc}}
|
|
\index{initFunc@{initFunc}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{initFunc()}{initFunc()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a8afd07d0150c5aa19755033734376ef3}
|
|
void PMusrfit\+Func\+::init\+Func (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Initializes all member variables to default values.
|
|
|
|
\doxylink{classPMusrfitFunc_a8afd07d0150c5aa19755033734376ef3}{PMusrfit\+Func\+::init\+Func} initializes all member variables to default values.
|
|
|
|
Sets name and abbreviation to "{}\+Un\+Def"{}, number of parameters to -\/1, and clears the parameter list. \Hypertarget{classPMusrfitFunc_a562f707fc93568cbeb66f7f77d3ef9b3}\index{PMusrfitFunc@{PMusrfitFunc}!setAbbrv@{setAbbrv}}
|
|
\index{setAbbrv@{setAbbrv}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{setAbbrv()}{setAbbrv()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a562f707fc93568cbeb66f7f77d3ef9b3}
|
|
void PMusrfit\+Func\+::set\+Abbrv (\begin{DoxyParamCaption}\item[{QString}]{abbrv}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the function abbreviation.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em abbrv} & Abbreviation used in msr-\/files (e.\+g., "{}sg"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPMusrfitFunc_aad99ca8a5ff53b5f85b78fc31b92a382}\index{PMusrfitFunc@{PMusrfitFunc}!setName@{setName}}
|
|
\index{setName@{setName}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{setName()}{setName()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_aad99ca8a5ff53b5f85b78fc31b92a382}
|
|
void PMusrfit\+Func\+::set\+Name (\begin{DoxyParamCaption}\item[{QString}]{name}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the function name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Full function name (e.\+g., "{}simple\+Gss"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPMusrfitFunc_a20af00a7c649360f325948708491a1d6}\index{PMusrfitFunc@{PMusrfitFunc}!setNoOfParam@{setNoOfParam}}
|
|
\index{setNoOfParam@{setNoOfParam}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{setNoOfParam()}{setNoOfParam()}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a20af00a7c649360f325948708491a1d6}
|
|
void PMusrfit\+Func\+::set\+No\+Of\+Param (\begin{DoxyParamCaption}\item[{int}]{ival}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the number of parameters this function takes.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em ival} & Number of parameters. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{classPMusrfitFunc_af51c07a9c3b381a4e4afd66f07c5afb0}\index{PMusrfitFunc@{PMusrfitFunc}!fAbbrv@{fAbbrv}}
|
|
\index{fAbbrv@{fAbbrv}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{fAbbrv}{fAbbrv}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_af51c07a9c3b381a4e4afd66f07c5afb0}
|
|
QString PMusrfit\+Func\+::f\+Abbrv\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
abbreviation for msr-\/files
|
|
|
|
\Hypertarget{classPMusrfitFunc_a0a925ddbaafaca6ec88fa2949518da33}\index{PMusrfitFunc@{PMusrfitFunc}!fName@{fName}}
|
|
\index{fName@{fName}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{fName}{fName}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a0a925ddbaafaca6ec88fa2949518da33}
|
|
QString PMusrfit\+Func\+::f\+Name\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
full function name
|
|
|
|
\Hypertarget{classPMusrfitFunc_ad84707dfe1a1b1e5aa46179109d483f6}\index{PMusrfitFunc@{PMusrfitFunc}!fNoOfParam@{fNoOfParam}}
|
|
\index{fNoOfParam@{fNoOfParam}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{fNoOfParam}{fNoOfParam}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_ad84707dfe1a1b1e5aa46179109d483f6}
|
|
int PMusrfit\+Func\+::f\+No\+Of\+Param\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
number of parameters
|
|
|
|
\Hypertarget{classPMusrfitFunc_a4aeae21bf9959ae68aaada0c42e11563}\index{PMusrfitFunc@{PMusrfitFunc}!fParam@{fParam}}
|
|
\index{fParam@{fParam}!PMusrfitFunc@{PMusrfitFunc}}
|
|
\doxysubsubsection{\texorpdfstring{fParam}{fParam}}
|
|
{\footnotesize\ttfamily \label{classPMusrfitFunc_a4aeae21bf9959ae68aaada0c42e11563}
|
|
QVector$<$\mbox{\hyperlink{classPFuncParam}{PFunc\+Param}}$>$ PMusrfit\+Func\+::f\+Param\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
parameter definitions
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PMusrfitFunc_8h}{PMusrfit\+Func.\+h}}\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PMusrfitFunc_8cpp}{PMusrfit\+Func.\+cpp}}\end{DoxyCompactItemize}
|