205 lines
9.8 KiB
TeX
205 lines
9.8 KiB
TeX
\doxysection{PFunc\+Param Class Reference}
|
|
\hypertarget{classPFuncParam}{}\label{classPFuncParam}\index{PFuncParam@{PFuncParam}}
|
|
|
|
|
|
The \doxylink{classPFuncParam}{PFunc\+Param} class represents a parameter of a musrfit function.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$PMusrfit\+Func.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classPFuncParam_ae667159979ec0606f1a5693655ed2274}{PFunc\+Param}} ()
|
|
\begin{DoxyCompactList}\small\item\em Constructor. Initializes to default values. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPFuncParam_a51518d19ef55504739fe36ce2746bed5}{\texorpdfstring{$\sim$}{\string~}\+PFunc\+Param}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPFuncParam_a7a5bac4dfe5ffa446569fe778f8052fb}{init\+Param}} ()
|
|
\begin{DoxyCompactList}\small\item\em Initializes all member variables to default values. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPFuncParam_ad61f5aaa7fa748a6c932d90510101b7d}{set\+Param\+Name}} (QString name)
|
|
\begin{DoxyCompactList}\small\item\em Sets the parameter name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPFuncParam_a181d6bd1c6cf6f2b08c15405d631d788}{set\+Param\+Value}} (double dval)
|
|
\begin{DoxyCompactList}\small\item\em Sets the default parameter value. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPFuncParam_a1b761560d7df3a55a27c0749a228582c}{set\+Param\+Map}} (bool \mbox{\hyperlink{classPFuncParam_a10e6271f93690d4f28693fa7c59a560b}{is\+Map}})
|
|
\begin{DoxyCompactList}\small\item\em Sets whether this parameter should be a map. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPFuncParam_af6dfacfaba9e1f9d67b8d451f384d7e4}{get\+Param\+Name}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the parameter name. \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{classPFuncParam_a672e01363cc76c6cedc09c9e43204357}{get\+Param\+Value}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the default parameter value. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{classPFuncParam_a10e6271f93690d4f28693fa7c59a560b}{is\+Map}} ()
|
|
\begin{DoxyCompactList}\small\item\em Checks if this is a map parameter. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
QString \mbox{\hyperlink{classPFuncParam_a4e5a094ab4c91fe2543b423fb378a636}{f\+Name}}
|
|
\begin{DoxyCompactList}\small\item\em parameter name \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{classPFuncParam_a3430a297185da6109db171023fe2dc84}{f\+Value}}
|
|
\begin{DoxyCompactList}\small\item\em default parameter value \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{classPFuncParam_ad0f269dc50f815b82472281ddabf9ddb}{f\+Map}}
|
|
\begin{DoxyCompactList}\small\item\em flag indicating if this is a map (run-\/specific) parameter \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
The \doxylink{classPFuncParam}{PFunc\+Param} class represents a parameter of a musrfit function.
|
|
|
|
This class holds information about a single parameter of a musrfit theory function, including its name, default value, and whether it should be treated as a map (run-\/specific parameter) rather than a global parameter.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classPFuncParam_ae667159979ec0606f1a5693655ed2274}\index{PFuncParam@{PFuncParam}!PFuncParam@{PFuncParam}}
|
|
\index{PFuncParam@{PFuncParam}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{PFuncParam()}{PFuncParam()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_ae667159979ec0606f1a5693655ed2274}
|
|
PFunc\+Param\+::\+PFunc\+Param (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Constructor. Initializes to default values.
|
|
|
|
\Hypertarget{classPFuncParam_a51518d19ef55504739fe36ce2746bed5}\index{PFuncParam@{PFuncParam}!````~PFuncParam@{\texorpdfstring{$\sim$}{\string~}PFuncParam}}
|
|
\index{````~PFuncParam@{\texorpdfstring{$\sim$}{\string~}PFuncParam}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PFuncParam()}{\string~PFuncParam()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a51518d19ef55504739fe36ce2746bed5}
|
|
PFunc\+Param\+::\texorpdfstring{$\sim$}{\string~}\+PFunc\+Param (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{classPFuncParam_af6dfacfaba9e1f9d67b8d451f384d7e4}\index{PFuncParam@{PFuncParam}!getParamName@{getParamName}}
|
|
\index{getParamName@{getParamName}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{getParamName()}{getParamName()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_af6dfacfaba9e1f9d67b8d451f384d7e4}
|
|
QString PFunc\+Param\+::get\+Param\+Name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the parameter name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Parameter name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPFuncParam_a672e01363cc76c6cedc09c9e43204357}\index{PFuncParam@{PFuncParam}!getParamValue@{getParamValue}}
|
|
\index{getParamValue@{getParamValue}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{getParamValue()}{getParamValue()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a672e01363cc76c6cedc09c9e43204357}
|
|
double PFunc\+Param\+::get\+Param\+Value (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the default parameter value.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Default value.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPFuncParam_a7a5bac4dfe5ffa446569fe778f8052fb}\index{PFuncParam@{PFuncParam}!initParam@{initParam}}
|
|
\index{initParam@{initParam}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{initParam()}{initParam()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a7a5bac4dfe5ffa446569fe778f8052fb}
|
|
void PFunc\+Param\+::init\+Param (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Initializes all member variables to default values.
|
|
|
|
Sets name to "{}\+Un\+Def"{}, value to 0.\+0, and map flag to false. \Hypertarget{classPFuncParam_a10e6271f93690d4f28693fa7c59a560b}\index{PFuncParam@{PFuncParam}!isMap@{isMap}}
|
|
\index{isMap@{isMap}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{isMap()}{isMap()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a10e6271f93690d4f28693fa7c59a560b}
|
|
bool PFunc\+Param\+::is\+Map (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Checks if this is a map parameter.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
true if this is a run-\/specific (map) parameter.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPFuncParam_a1b761560d7df3a55a27c0749a228582c}\index{PFuncParam@{PFuncParam}!setParamMap@{setParamMap}}
|
|
\index{setParamMap@{setParamMap}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{setParamMap()}{setParamMap()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a1b761560d7df3a55a27c0749a228582c}
|
|
void PFunc\+Param\+::set\+Param\+Map (\begin{DoxyParamCaption}\item[{bool}]{is\+Map}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets whether this parameter should be a map.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em is\+Map} & true if this is a run-\/specific (map) parameter. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPFuncParam_ad61f5aaa7fa748a6c932d90510101b7d}\index{PFuncParam@{PFuncParam}!setParamName@{setParamName}}
|
|
\index{setParamName@{setParamName}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{setParamName()}{setParamName()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_ad61f5aaa7fa748a6c932d90510101b7d}
|
|
void PFunc\+Param\+::set\+Param\+Name (\begin{DoxyParamCaption}\item[{QString}]{name}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the parameter name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & Parameter name (e.\+g., "{}rate"{}, "{}phase"{}, "{}sigma"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPFuncParam_a181d6bd1c6cf6f2b08c15405d631d788}\index{PFuncParam@{PFuncParam}!setParamValue@{setParamValue}}
|
|
\index{setParamValue@{setParamValue}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{setParamValue()}{setParamValue()}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a181d6bd1c6cf6f2b08c15405d631d788}
|
|
void PFunc\+Param\+::set\+Param\+Value (\begin{DoxyParamCaption}\item[{double}]{dval}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the default parameter value.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em dval} & Default value. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{classPFuncParam_ad0f269dc50f815b82472281ddabf9ddb}\index{PFuncParam@{PFuncParam}!fMap@{fMap}}
|
|
\index{fMap@{fMap}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{fMap}{fMap}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_ad0f269dc50f815b82472281ddabf9ddb}
|
|
bool PFunc\+Param\+::f\+Map\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
flag indicating if this is a map (run-\/specific) parameter
|
|
|
|
\Hypertarget{classPFuncParam_a4e5a094ab4c91fe2543b423fb378a636}\index{PFuncParam@{PFuncParam}!fName@{fName}}
|
|
\index{fName@{fName}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{fName}{fName}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a4e5a094ab4c91fe2543b423fb378a636}
|
|
QString PFunc\+Param\+::f\+Name\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
parameter name
|
|
|
|
\Hypertarget{classPFuncParam_a3430a297185da6109db171023fe2dc84}\index{PFuncParam@{PFuncParam}!fValue@{fValue}}
|
|
\index{fValue@{fValue}!PFuncParam@{PFuncParam}}
|
|
\doxysubsubsection{\texorpdfstring{fValue}{fValue}}
|
|
{\footnotesize\ttfamily \label{classPFuncParam_a3430a297185da6109db171023fe2dc84}
|
|
double PFunc\+Param\+::f\+Value\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
default parameter value
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PMusrfitFunc_8h}{PMusrfit\+Func.\+h}}\end{DoxyCompactItemize}
|