FitParameterContainerItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Job/FitParameterContainerItem.h
//! @brief     Defines class FitParameterContainerItem
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_JOB_FITPARAMETERCONTAINERITEM_H
#define BORNAGAIN_GUI_MODEL_JOB_FITPARAMETERCONTAINERITEM_H
 
#include "GUI/Model/BaseItem/SessionItem.h"
 
namespace mumufit {
 
class Parameters;
}
class FitParameterItem;
class ParameterItem;
 
//! The FitParameterContainerItem class is a collection of all defined fit parameters in JobItem.
 
class FitParameterContainerItem : public SessionItem {
private:
    static constexpr auto T_FIT_PARAMETERS{"Data tag"};
 
public:
    static constexpr auto M_TYPE{"FitParameterContainer"};
 
    FitParameterContainerItem();
 
    //! Creates fit parameter from given ParameterItem, sets starting value to the value
    //! of ParameterItem, copies link.
    void createFitParameter(ParameterItem* parameterItem);
 
    //! Adds given parameterItem to the existing fit parameter with display name fitParName.
    //! If parameterItem is already linked with another fitParameter, it will be relinked
    void addToFitParameter(ParameterItem* parameterItem, const QString& fitParName);
 
    //! get the fit parameter item whose link matches the given link.
    //!
    //! The link is a ParameterItem's path
    FitParameterItem* fitParameterItem(const QString& link) const;
 
    //! get the fit parameter item which links the given parameterItem.
    FitParameterItem* fitParameterItem(const ParameterItem* parameterItem) const;
 
    QVector<FitParameterItem*> fitParameterItems() const;
 
    //! Returns list of fit parameter display names
    QStringList fitParameterNames() const;
 
    void removeLink(const ParameterItem* parameterItem);
 
 
    bool isEmpty();
    void setValuesInParameterContainer(const QVector<double>& values,
                                       class ParameterContainerItem* parameterContainer);
    mumufit::Parameters createParameters() const;
};
 
#endif // BORNAGAIN_GUI_MODEL_JOB_FITPARAMETERCONTAINERITEM_H