File: BeamDistributionItem.h

package info (click to toggle)
bornagain 23.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,948 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (50 lines) | stat: -rw-r--r-- 1,762 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Beam/BeamDistributionItem.h
//! @brief     Defines class BeamDistributionItem.
//!
//! @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_BEAM_BEAMDISTRIBUTIONITEM_H
#define BORNAGAIN_GUI_MODEL_BEAM_BEAMDISTRIBUTIONITEM_H

#include "GUI/Model/Beam/DistributionCatalog.h"
#include "GUI/Model/Beam/DistributionItems.h"
#include "GUI/Model/Descriptor/PolyPtr.h"
#include "Param/Distrib/ParameterDistribution.h"

//! Holds a DistributionItem, for use as a beam parameter distribution.

class BeamDistributionItem {
public:
    BeamDistributionItem(double scale = 1.);
    virtual ~BeamDistributionItem();

    virtual void writeTo(QXmlStreamWriter* w) const;
    virtual void readFrom(QXmlStreamReader* r);

    virtual double centralValue() const;
    void resetToValue(double value);

    void setScaleFactor(double v) { m_scale = v; }
    double scaleFactor() const { return m_scale; }

    DistributionItem* distributionItem() const { return m_distribution.certainItem(); }
    PolyPtr<DistributionItem, DistributionCatalog>& distributionSelection()
    {
        return m_distribution;
    }

protected:
    double m_scale;
    PolyPtr<DistributionItem, DistributionCatalog> m_distribution;
};

#endif // BORNAGAIN_GUI_MODEL_BEAM_BEAMDISTRIBUTIONITEM_H