FitParameterItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Job/FitParameterItem.h
//! @brief     Defines class FitParameterItem
//!
//! @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_FITPARAMETERITEM_H
#define BORNAGAIN_GUI_MODEL_JOB_FITPARAMETERITEM_H
 
#include "Fit/Param/AttLimits.h"
#include "GUI/Model/BaseItem/SessionItem.h"
 
class FitParameterLinkItem;
 
//! FitParameterItems is a collection of items to define fit parameters in GUI.
 
//! The FitParameterItem class represents a fit parameter in GUI. Contains links to corresponding
//! ParameterItem's in a tuning tree.
 
class FitParameterItem : public SessionItem {
private:
    static constexpr auto P_TYPE{"Type"};
    static constexpr auto P_START_VALUE{"Value"};
    static constexpr auto P_MIN{"Min"};
    static constexpr auto P_MAX{"Max"};
    static constexpr auto T_LINK{"Link tag"};
 
public:
    static constexpr auto M_TYPE{"FitParameter"};
 
    FitParameterItem();
 
    void initMinMaxValues(const RealLimits& limits);
 
    AttLimits attLimits() const;
 
    bool isValid() const;
 
    double startValue() const;
    void setStartValue(double start_value);
    SessionItem* startValueItem() const;
 
    double minimum() const;
    void setMinimum(double minimum);
    SessionItem* minimumItem() const;
 
    double maximum() const;
    void setMaximum(double maximum);
    SessionItem* maximumItem() const;
 
    void addLink(const QString& title, const QString& link);
    void removeLink(const QString& link);
 
    QVector<FitParameterLinkItem*> linkItems() const;
    QStringList links() const;
 
    SessionItem* typeItem() const;
 
private:
    QString parameterType() const;
    void onTypeChange();
    void setLimitEnabled(const QString& name, bool enabled);
    bool isLimited() const;
    bool isFree() const;
    bool isLowerLimited() const;
    bool isUpperLimited() const;
    bool isFixed() const;
};
 
#endif // BORNAGAIN_GUI_MODEL_JOB_FITPARAMETERITEM_H