musrWiz 0.1.0
Loading...
Searching...
No Matches
PFuncParam Class Reference

The PFuncParam class represents a parameter of a musrfit function. More...

#include <PMusrfitFunc.h>

Public Member Functions

 PFuncParam ()
 Constructor. Initializes to default values.
 
 ~PFuncParam ()
 Destructor.
 
void initParam ()
 Initializes all member variables to default values.
 
void setParamName (QString name)
 Sets the parameter name.
 
void setParamValue (double dval)
 Sets the default parameter value.
 
void setParamMap (bool isMap)
 Sets whether this parameter should be a map.
 
QString getParamName ()
 Returns the parameter name.
 
double getParamValue ()
 Returns the default parameter value.
 
bool isMap ()
 Checks if this is a map parameter.
 

Private Attributes

QString fName
 parameter name
 
double fValue
 default parameter value
 
bool fMap
 flag indicating if this is a map (run-specific) parameter
 

Detailed Description

The PFuncParam 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.

Constructor & Destructor Documentation

◆ PFuncParam()

PFuncParam::PFuncParam ( )
inline

Constructor. Initializes to default values.

◆ ~PFuncParam()

PFuncParam::~PFuncParam ( )
inline

Destructor.

Member Function Documentation

◆ getParamName()

QString PFuncParam::getParamName ( )
inline

Returns the parameter name.

Returns
Parameter name.

◆ getParamValue()

double PFuncParam::getParamValue ( )
inline

Returns the default parameter value.

Returns
Default value.

◆ initParam()

void PFuncParam::initParam ( )
inline

Initializes all member variables to default values.

Sets name to "UnDef", value to 0.0, and map flag to false.

◆ isMap()

bool PFuncParam::isMap ( )
inline

Checks if this is a map parameter.

Returns
true if this is a run-specific (map) parameter.

◆ setParamMap()

void PFuncParam::setParamMap ( bool isMap)
inline

Sets whether this parameter should be a map.

Parameters
isMaptrue if this is a run-specific (map) parameter.

◆ setParamName()

void PFuncParam::setParamName ( QString name)
inline

Sets the parameter name.

Parameters
nameParameter name (e.g., "rate", "phase", "sigma").

◆ setParamValue()

void PFuncParam::setParamValue ( double dval)
inline

Sets the default parameter value.

Parameters
dvalDefault value.

Member Data Documentation

◆ fMap

bool PFuncParam::fMap
private

flag indicating if this is a map (run-specific) parameter

◆ fName

QString PFuncParam::fName
private

parameter name

◆ fValue

double PFuncParam::fValue
private

default parameter value


The documentation for this class was generated from the following file: