BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
DistributionItemCatalog.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file GUI/Model/CatDevice/DistributionItemCatalog.h
6 //! @brief Defines class DistributionItemCatalog
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2021
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************************************
14 
15 #ifndef BORNAGAIN_GUI_MODEL_CATDEVICE_DISTRIBUTIONITEMCATALOG_H
16 #define BORNAGAIN_GUI_MODEL_CATDEVICE_DISTRIBUTIONITEMCATALOG_H
17 
18 #include <QString>
19 #include <QVector>
20 
21 class DistributionItem;
22 
24 public:
26 
27  // Do not change the numbering! It is serialized!
28  enum class Type : uint8_t {
29  None = 0,
30  Gate = 1,
31  Lorentz = 2,
32  Gaussian = 3,
33  LogNormal = 4,
34  Cosine = 5,
35  Trapezoid = 6
36  };
37 
38  struct UiInfo {
39  QString menuEntry;
40  QString description;
41  QString iconPath;
42  };
43 
44  //! Creates the item of the given type.
46 
47  //! Available types of items.
48  //!
49  //! Contains also type "None".
50  //! This list is sorted as expected in the UI (e.g. in combo box)
51  static QVector<Type> types();
52 
53  //! Types of symmetric distributions
54  //!
55  //! Contains also type "None".
56  //! This list is sorted as expected in the UI (e.g. in combo box)
57  static QVector<Type> symmetricTypes();
58 
59  //! UiInfo on the given type.
60  static UiInfo uiInfo(Type t);
61 
62  //! Returns the enum type of the given item.
63  static Type type(const DistributionItem* item);
64 };
65 
66 #endif // BORNAGAIN_GUI_MODEL_CATDEVICE_DISTRIBUTIONITEMCATALOG_H
static QVector< Type > symmetricTypes()
Types of symmetric distributions.
static Type type(const DistributionItem *item)
Returns the enum type of the given item.
static UiInfo uiInfo(Type t)
UiInfo on the given type.
static DistributionItem * create(Type type)
Creates the item of the given type.
static QVector< Type > types()
Available types of items.