BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FitParameterHelper.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file GUI/coregui/Models/FitParameterHelper.h
6 //! @brief Defines class FitParameterHelper
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************************************
14 
15 #ifndef BORNAGAIN_GUI_COREGUI_MODELS_FITPARAMETERHELPER_H
16 #define BORNAGAIN_GUI_COREGUI_MODELS_FITPARAMETERHELPER_H
17 
18 #include <QStringList>
19 
20 class ParameterItem;
21 class FitParameterItem;
23 
24 //! The FitParameterHelper class contains set of convenience static methods to handle
25 //! various fitting items in given JobItem.
26 
28 public:
29  static void createFitParameter(FitParameterContainerItem* container,
30  ParameterItem* parameterItem);
31 
33  ParameterItem* parameterItem);
34  static void addToFitParameter(FitParameterContainerItem* container,
35  ParameterItem* parameterItem, const QString& fitParName);
36 
38  ParameterItem* parameterItem);
39 
40  static QStringList getFitParameterNames(FitParameterContainerItem* container);
41  static QString getParameterItemPath(const ParameterItem* parameterItem);
43  const QString& link);
44 };
45 
46 #endif // BORNAGAIN_GUI_COREGUI_MODELS_FITPARAMETERHELPER_H
The FitParameterHelper class contains set of convenience static methods to handle various fitting ite...
static void createFitParameter(FitParameterContainerItem *container, ParameterItem *parameterItem)
Creates fit parameter from given ParameterItem, sets starting value to the value of ParameterItem,...
static ParameterItem * getParameterItem(FitParameterContainerItem *container, const QString &link)
Returns ParameterItem corresponding to given link.
static QStringList getFitParameterNames(FitParameterContainerItem *container)
Returns list of fit parameter display names.
static FitParameterItem * getFitParameterItem(FitParameterContainerItem *container, ParameterItem *parameterItem)
Returns fFitParameterItem corresponding to given ParameterItem.
static void removeFromFitParameters(FitParameterContainerItem *container, ParameterItem *parameterItem)
Removes link to given parameterItem from fit parameters.
static void addToFitParameter(FitParameterContainerItem *container, ParameterItem *parameterItem, const QString &fitParName)
Adds given parameterItem to the existing fit parameter with display name fitParName.
static QString getParameterItemPath(const ParameterItem *parameterItem)
return path to given item in the ParameterTreeContainer
The FitParameterItem class represents a fit parameter in GUI.
The ParameterItem class represent a tuning value in a parameter tuning tree.