ParameterTreeUtils.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Model/ParameterTreeUtils.h
//! @brief     Defines namespace GUI::Model::ParameterTreeUtils
//!
//! @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_MODEL_PARAMETERTREEUTILS_H
#define BORNAGAIN_GUI_MODEL_MODEL_PARAMETERTREEUTILS_H
 
#include <QPair>
#include <QString>
#include <functional>
#include <variant>
 
class JobItem;
class ParameterItem;
class ParameterLabelItem;
class ParameterContainerItem;
class DoubleDescriptor;
class VectorDescriptor;
class ParticleLayoutItem;
class ItemWithParticles;
class Interference2DAbstractLatticeItem;
class BeamItem;
class BeamDistributionItem;
class DetectorItem;
class BackgroundItem;
class InstrumentItem;
 
//! The ParameterTreeBuilder contains helper functions to create container
//! with ParameterItems. The ParameterItem appears in RealTimeView and provides real
//! time tuning of MultiLayerItem and InstrumentItem.
 
class ParameterTreeBuilder {
public:
    ParameterTreeBuilder(JobItem* jobItem, bool recreateBackupValues);
 
    void build();
 
private:
    //! add the job's materials
    void addMaterials();
 
    //! add the job's sample
    void addSample();
    void addInstrument();
    void addParameterItem(ParameterLabelItem* parent, const DoubleDescriptor& d,
                          const QString& label = QString());
    void addParameterItem(ParameterLabelItem* parent, const VectorDescriptor& d);
    void addParameterItem(ParameterLabelItem* parent,
                          const std::variant<VectorDescriptor, DoubleDescriptor>& v);
    ParameterContainerItem* parameterContainer();
    bool allowMagneticFields() const;
 
    void addInterference(ParameterLabelItem* layoutLabel, const ParticleLayoutItem* layout);
 
    //! Returns the top label which was created for the particle
    ParameterLabelItem* addParticle(ParameterLabelItem* parentLabel, ItemWithParticles* p,
                                    bool enableAbundance, bool enablePosition = true);
    void addLattice(ParameterLabelItem* parentLabel, const Interference2DAbstractLatticeItem* itf);
    void addRotation(ParameterLabelItem* parentLabel, ItemWithParticles* p);
 
    void addBeamDistribution(ParameterLabelItem* parentLabel,
                             BeamDistributionItem* distributionItem, const QString& label,
                             bool withMean = true);
 
    void addDetector(ParameterLabelItem* parentLabel, DetectorItem* detector);
    void addBackground(ParameterLabelItem* instrumentLabel, BackgroundItem* backgroundItem);
    void addPolarization(ParameterLabelItem* instrumentLabel, const InstrumentItem* instrument);
 
private:
    JobItem* m_jobItem;
    bool m_recreateBackupValues;
};
 
#endif // BORNAGAIN_GUI_MODEL_MODEL_PARAMETERTREEUTILS_H