SimulationOptionsItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Support/Data/SimulationOptionsItem.h
//! @brief     Defines class SimulationOptionsItem
//!
//! @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_SUPPORT_DATA_SIMULATIONOPTIONSITEM_H
#define BORNAGAIN_GUI_SUPPORT_DATA_SIMULATIONOPTIONSITEM_H
 
class QXmlStreamWriter;
class QXmlStreamReader;
 
//! The SimulationOptionsItem class holds simulation status (run policy, number of threads,
//! integration flag). Used in SimulationView to define job settings. When job is started,
//! item is copied to the job.
 
class SimulationOptionsItem {
public:
    explicit SimulationOptionsItem();
 
    void setNumberOfThreads(unsigned n);
    unsigned numberOfThreads() const;
 
    void setRunImmediately(bool runImmediately);
    bool runImmediately() const;
    bool runInBackground() const;
 
    void setUseMonteCarloIntegration(unsigned numberOfPoints);
    void setUseAnalytical();
    bool useMonteCarloIntegration() const;
    bool useAnalytical() const;
 
    unsigned numberOfMonteCarloPoints() const;
 
    void setUseAverageMaterials(bool useAverageMaterials);
    bool useAverageMaterials() const;
 
    void setIncludeSpecularPeak(bool includeSpecularPeak);
    bool includeSpecularPeak() const;
 
    void writeContentTo(QXmlStreamWriter* writer) const;
    void readContentFrom(QXmlStreamReader* reader);
 
private:
    bool m_runImmediately;
    unsigned m_numberOfThreads;
    bool m_computationMethodAnalytical;
    unsigned m_numberOfMonteCarloPoints;
    bool m_useAverageMaterials;
    bool m_includeSpecularPeak;
};
 
#endif // BORNAGAIN_GUI_SUPPORT_DATA_SIMULATIONOPTIONSITEM_H