BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
JobItemUtils.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file GUI/coregui/Models/JobItemUtils.h
6 //! @brief Defines class JobItemUtils
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************************************
14 
15 #ifndef BORNAGAIN_GUI_COREGUI_MODELS_JOBITEMUTILS_H
16 #define BORNAGAIN_GUI_COREGUI_MODELS_JOBITEMUTILS_H
17 
20 #include <QMap>
21 
22 class DataItem;
23 class InstrumentItem;
24 class JobItem;
25 class ISimulation;
26 
27 //! Contains set of convenience methods to set data to the IntensityDataItem from domain simulation.
28 //! Used to modify OutputData's axes units as requested by IntensityDataItem.
29 
30 namespace JobItemUtils {
31 //! updates axes of OutputData in IntensityData item
32 void updateDataAxes(DataItem* intensityItem, const InstrumentItem* instrumentItem);
33 
34 //! returns axes units names from their domain counterpart
35 QString nameFromAxesUnits(Axes::Units units);
36 
37 //! returns domain axes units type from their GUI name
38 Axes::Units axesUnitsFromName(const QString& name);
39 
40 void setIntensityItemAxesUnits(DataItem* intensityItem, const InstrumentItem* instrumentItem);
41 
42 void setIntensityItemAxesUnits(DataItem* intensityItem, const IUnitConverter& converter);
43 
44 void createDefaultDetectorMap(DataItem* intensityItem, const InstrumentItem* instrumentItem);
45 
46 //! Sets simulation results into the DataItem
47 void setResults(DataItem* intensityItem, const ISimulation* simulation);
48 
50 } // namespace JobItemUtils
51 
52 #endif // BORNAGAIN_GUI_COREGUI_MODELS_JOBITEMUTILS_H
Defines class ComboProperty.
Defines common detector interface.
Custom property to define list of string values with multiple selections.
Definition: ComboProperty.h:25
Provides common functionality for IntensityDataItem and SpecularDataItem.
Definition: DataItem.h:29
Abstract base class of OffSpecularSimulation, GISASSimulation and SpecularSimulation.
Definition: ISimulation.h:38
Interface to provide axis translations to different units for simulation output.
Contains set of convenience methods to set data to the IntensityDataItem from domain simulation.
Definition: JobItemUtils.h:30
ComboProperty availableUnits(const IUnitConverter &converter)
void setResults(DataItem *intensityItem, const ISimulation *simulation)
Sets simulation results into the DataItem.
void updateDataAxes(DataItem *intensityItem, const InstrumentItem *instrumentItem)
updates axes of OutputData in IntensityData item
Axes::Units axesUnitsFromName(const QString &name)
returns domain axes units type from their GUI name
QString nameFromAxesUnits(Axes::Units units)
returns axes units names from their domain counterpart
void setIntensityItemAxesUnits(DataItem *intensityItem, const InstrumentItem *instrumentItem)
Sets axes units suitable for given instrument.
void createDefaultDetectorMap(DataItem *intensityItem, const InstrumentItem *instrumentItem)
QString const & name(EShape k)
Definition: particles.cpp:21