SimulationSetupAssistant.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/coregui/Views/SimulationWidgets/SimulationSetupAssistant.h
//! @brief     Defines class SimulationSetupAssistant
//!
//! @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_COREGUI_VIEWS_SIMULATIONWIDGETS_SIMULATIONSETUPASSISTANT_H
#define BORNAGAIN_GUI_COREGUI_VIEWS_SIMULATIONWIDGETS_SIMULATIONSETUPASSISTANT_H
 
#include <QStringList>
 
class MultiLayerItem;
class InstrumentItem;
class RealDataItem;
 
//! The SimulationSetupAssistant class provides sample, instrument and real data validation before
//! submitting the job.
 
class SimulationSetupAssistant {
public:
    SimulationSetupAssistant();
 
    bool isValidSimulationSetup(const MultiLayerItem* multiLayerItem,
                                const InstrumentItem* instrumentItem,
                                const RealDataItem* realData = 0);
 
private:
    void clear();
    void checkMultiLayerItem(const MultiLayerItem* multiLayerItem);
    void checkInstrumentItem(const InstrumentItem* instrumentItem);
    void checkFittingSetup(const InstrumentItem* instrumentItem, const RealDataItem* realData);
    QString composeMessage();
 
    bool m_isValid;
    QStringList m_messages;
};
 
#endif // BORNAGAIN_GUI_COREGUI_VIEWS_SIMULATIONWIDGETS_SIMULATIONSETUPASSISTANT_H