SpecularBeamInclinationItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Device/SpecularBeamInclinationItem.h
//! @brief     Declares the class SpecularBeamInclinationItem
//!
//! @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_DEVICE_SPECULARBEAMINCLINATIONITEM_H
#define BORNAGAIN_GUI_MODEL_DEVICE_SPECULARBEAMINCLINATIONITEM_H
 
#include "GUI/Model/Device/BeamDistributionItem.h"
#include "GUI/Model/Device/PointwiseAxisItem.h"
 
//! BeamInclinationAxisItem contains inclination angle axis for specular/off-specular
//! simulations and also provides distribution functionality.
//! Considering distribution, differs from BeamInclinationAngleItem
//! by any distribution mean value being always zero.
 
class SpecularBeamInclinationItem : public BeamDistributionItem {
public:
    explicit SpecularBeamInclinationItem(const InstrumentItem* owningInstrument);
 
    void serialize(Streamer& s) override;
    double scaleFactor() const override;
 
    //! The currently selected axis
    BasicAxisItem* alphaAxis() const;
 
    //! True if a pointwise axis was defined.
    //!
    //! It still is no necessarily the selected axis!
    //! Not to be confused with pointwiseAlphaAxisSelected
    bool pointwiseAlphaAxisDefined() const;
 
    //! True if pointwise axis is selected.
    //!
    //! Not to be confused with pointwiseAlphaAxisDefined
    bool pointwiseAlphaAxisSelected() const;
 
    //! True if uniform axis is selected.
    bool uniformAlphaAxisSelected() const;
 
    void selectUniformAxis();
    void selectPointwiseAxis();
 
    void initUniformAxis(const IAxis& axis);
    void initPointwiseAxis(const IAxis& axis, QString units);
 
private:
    std::unique_ptr<BasicAxisItem> m_uniformAlphaAxis;
    std::unique_ptr<PointwiseAxisItem> m_pointwiseAlphaAxis;
    bool m_currentAxisIsUniformAxis;
 
    const InstrumentItem* m_owningInstrument;
};
 
#endif // BORNAGAIN_GUI_MODEL_DEVICE_SPECULARBEAMINCLINATIONITEM_H