SimulationView Class Reference

Description

Widget to define a simulation. Contains:

• Elements to select instrument, sample and real data.
• Elements to set options like number of threads.
• Buttons to run simulation or to export as a Python script

Definition at line 38 of file SimulationView.h.

Inheritance diagram for SimulationView:

Collaboration diagram for SimulationView:

Public Member Functions
	SimulationView (QWidget *parent, ProjectDocument *document)
void	exportPythonScript ()
void	simulate ()

Protected Member Functions
void	hideEvent (QHideEvent *) override
void	showEvent (QShowEvent *) override

Private Member Functions
QVector< InstrumentItem * >	collectedItems () const
SimulationOptionsItem *	optionsItem () const
void	readOptionsFromUI ()
	Read the entries in the UI and store in OptionsItem. More...
QVector< RealDataItem * >	realDataItems () const
QVector< MultiLayerItem * >	sampleItems () const
const InstrumentItem *	selectedInstrument () const
	Returns selected InstrumentItem taking into account that there might be several instruments with the same name. More...
const RealDataItem *	selectedRealData () const
	Returns selected real data item taking into account that there might be several items with the same name. More...
const MultiLayerItem *	selectedSample () const
	Returns selected sample (MultiLayerItem) taking into account that there might be several samples with the same name. More...
void	updateEnabling ()
	Update enabling of elements depending on other elements. More...
void	updateFunctionalityNarrowing ()
	Show/hide UI elements according to settings in current project. More...
void	updateSelection (QComboBox *comboBox, QStringList itemList, bool allowNone=false)
	Updates selection combo with string list while preserving previous selection. If allowNone == true, additional "None" item will be added to the combo. More...
QString	validateSimulationSetup (bool validateRealData) const
	Checks whether selection is correct for running a simulation. Returns empty string if valid, otherwise the error text. More...
void	writeOptionsToUI ()
	Write entries in OptionsItem to UI. More...

Private Attributes
ProjectDocument *	m_document
Ui::SimulationView *	m_ui

Constructor & Destructor Documentation

SimulationView()

SimulationView::SimulationView	(	QWidget *	parent,
		ProjectDocument *	document
	)

Definition at line 34 of file SimulationView.cpp.

    : QWidget(parent)
    , m_ui(new Ui::SimulationView)
    , m_document(document)
{
    m_ui->setupUi(this);
 
    setAttribute(Qt::WA_StyledBackground, true);
    setProperty("stylable", true); // for stylesheet addressing
 
    GroupBoxCollapser::installIntoGroupBox(m_ui->groupBox_3);
    GroupBoxCollapser::installIntoGroupBox(m_ui->groupBox_2);
    GroupBoxCollapser::installIntoGroupBox(m_ui->groupBox);
 
    auto* buttonGroup = new QButtonGroup(this);
    buttonGroup->addButton(m_ui->runPolicyImmediatelyRadio);
    buttonGroup->addButton(m_ui->runPolicyBackgroundRadio);
 
    auto* computationButtonGroup = new QButtonGroup(this);
    computationButtonGroup->addButton(m_ui->analyticalRadio);
    computationButtonGroup->addButton(m_ui->monteCarloRadio);
 
    buttonGroup = new QButtonGroup(this);
    buttonGroup->addButton(m_ui->ambientLayerRadio);
    buttonGroup->addButton(m_ui->averageLayerRadio);
 
    // -- fill combo for "number of threads"
    const int nthreads = static_cast<int>(std::thread::hardware_concurrency());
    m_ui->numberOfThreadsCombo->addItem(QString("Max (%1 threads)").arg(nthreads), nthreads);
    for (int i = nthreads - 1; i > 1; i--)
        m_ui->numberOfThreadsCombo->addItem(QString("%1 threads").arg(i), i);
    m_ui->numberOfThreadsCombo->addItem("1 thread", 1);
 
    updateFunctionalityNarrowing();
 
    connect(m_ui->simulateButton, &QPushButton::clicked, this, &SimulationView::simulate);
    connect(m_ui->exportToPyScriptButton, &QPushButton::clicked, this,
            &SimulationView::exportPythonScript);
    connect(computationButtonGroup, QOverload<int>::of(&QButtonGroup::buttonClicked), this,
            &SimulationView::updateEnabling);
 
    connect(m_ui->runPolicyImmediatelyRadio, &QRadioButton::toggled,
            [=]() { document->setModified(); });
 
    connect(m_ui->analyticalRadio, &QRadioButton::toggled, [=]() { document->setModified(); });
 
    connect(m_ui->averageLayerRadio, &QRadioButton::toggled, [=]() { document->setModified(); });
 
    connect(m_ui->numberOfThreadsCombo, QOverload<int>::of(&QComboBox::currentIndexChanged),
            [=]() { document->setModified(); });
 
    connect(m_ui->numberOfMonteCarloPoints, QOverload<int>::of(&QSpinBox::valueChanged),
            [=]() { document->setModified(); });
 
    connect(m_ui->includeSpecularCheck, &QCheckBox::toggled, [=]() { document->setModified(); });
 
    connect(m_document, &ProjectDocument::modified, this,
            &SimulationView::updateFunctionalityNarrowing);
}

References exportPythonScript(), GroupBoxCollapser::installIntoGroupBox(), m_document, m_ui, ProjectDocument::modified(), simulate(), updateEnabling(), and updateFunctionalityNarrowing().

Here is the call graph for this function:

Member Function Documentation

collectedItems()

QVector< InstrumentItem * > SimulationView::collectedItems ( ) const

private

Definition at line 238 of file SimulationView.cpp.

{
    return m_document->collectedItems()->collectedItems();
}

References InstrumentCollection::collectedItems(), ProjectDocument::collectedItems(), and m_document.

Referenced by selectedInstrument().

Here is the call graph for this function:

exportPythonScript()

void SimulationView::exportPythonScript

(

)

Definition at line 152 of file SimulationView.cpp.

{
    readOptionsFromUI();
    if (const QString msg = validateSimulationSetup(false); !msg.isEmpty()) {
        QMessageBox::warning(this, "Can't export to Python",
                             "Can't export to Python with current settings\n\n" + msg);
        return;
    }
    auto* pythonWidget = new PythonScriptWidget(GUI::Global::mainWindow);
    pythonWidget->show();
    pythonWidget->raise();
    pythonWidget->generatePythonScript(selectedSample(), selectedInstrument(), *optionsItem(),
                                       ProjectManager::instance()->projectDir());
}

References ProjectManager::instance(), GUI::Global::mainWindow, optionsItem(), GUI::Project::Utils::projectDir(), readOptionsFromUI(), selectedInstrument(), selectedSample(), validateSimulationSetup(), and GUI::View::Helpers::warning().

Referenced by SimulationView().

Here is the call graph for this function:

hideEvent()

void SimulationView::hideEvent ( QHideEvent *  )

overrideprotected

Definition at line 131 of file SimulationView.cpp.

{
    // Storing the options has do be done here because on a showEvent the values are set again from
    // the SimulationOptionsItem (=> keep values when switching views)
    readOptionsFromUI();
}

References readOptionsFromUI().

Here is the call graph for this function:

optionsItem()

SimulationOptionsItem * SimulationView::optionsItem ( ) const

private

Definition at line 248 of file SimulationView.cpp.

{
    return m_document->simulationOptionsItem();
}

References m_document, and ProjectDocument::simulationOptionsItem().

Referenced by exportPythonScript(), readOptionsFromUI(), simulate(), and writeOptionsToUI().

Here is the call graph for this function:

readOptionsFromUI()

void SimulationView::readOptionsFromUI ( )

private

Read the entries in the UI and store in OptionsItem.

Definition at line 167 of file SimulationView.cpp.

{
    optionsItem()->setRunImmediately(m_ui->runPolicyImmediatelyRadio->isChecked());
    optionsItem()->setNumberOfThreads(m_ui->numberOfThreadsCombo->currentData().toInt());
    if (m_ui->analyticalRadio->isChecked())
        optionsItem()->setUseAnalytical();
    else
        optionsItem()->setUseMonteCarloIntegration(m_ui->numberOfMonteCarloPoints->value());
    optionsItem()->setUseAverageMaterials(m_ui->averageLayerRadio->isChecked());
    optionsItem()->setIncludeSpecularPeak(m_ui->includeSpecularCheck->isChecked());
}

References m_ui, optionsItem(), SimulationOptionsItem::setIncludeSpecularPeak(), SimulationOptionsItem::setNumberOfThreads(), SimulationOptionsItem::setRunImmediately(), SimulationOptionsItem::setUseAnalytical(), SimulationOptionsItem::setUseAverageMaterials(), and SimulationOptionsItem::setUseMonteCarloIntegration().

Referenced by exportPythonScript(), hideEvent(), and simulate().

Here is the call graph for this function:

realDataItems()

QVector< RealDataItem * > SimulationView::realDataItems ( ) const

private

Definition at line 243 of file SimulationView.cpp.

{
    return m_document->realDataModel()->realDataItems();
}

References m_document, RealDataModel::realDataItems(), and ProjectDocument::realDataModel().

Referenced by selectedRealData().

Here is the call graph for this function:

sampleItems()

QVector< MultiLayerItem * > SimulationView::sampleItems ( ) const

private

Definition at line 233 of file SimulationView.cpp.

{
    return m_document->sampleItems()->sampleItems();
}

References m_document, ProjectDocument::sampleItems(), and MultiLayerItems::sampleItems().

Referenced by selectedSample().

Here is the call graph for this function:

selectedInstrument()

const InstrumentItem * SimulationView::selectedInstrument ( ) const

private

Returns selected InstrumentItem taking into account that there might be several instruments with the same name.

Definition at line 258 of file SimulationView.cpp.

{
    return collectedItems().value(m_ui->instrumentCombo->currentIndex(), nullptr);
}

References collectedItems(), and m_ui.

Referenced by exportPythonScript(), simulate(), and validateSimulationSetup().

Here is the call graph for this function:

selectedRealData()

const RealDataItem * SimulationView::selectedRealData ( ) const

private

Returns selected real data item taking into account that there might be several items with the same name.

Definition at line 263 of file SimulationView.cpp.

{
    return realDataItems().value(m_ui->realDataCombo->currentIndex() - 1, nullptr); // -1: "None"
}

References m_ui, and realDataItems().

Referenced by simulate(), and validateSimulationSetup().

Here is the call graph for this function:

selectedSample()

const MultiLayerItem * SimulationView::selectedSample ( ) const

private

Returns selected sample (MultiLayerItem) taking into account that there might be several samples with the same name.

Definition at line 253 of file SimulationView.cpp.

{
    return sampleItems().value(m_ui->sampleCombo->currentIndex(), nullptr);
}

References m_ui, and sampleItems().

Referenced by exportPythonScript(), simulate(), and validateSimulationSetup().

Here is the call graph for this function:

showEvent()

void SimulationView::showEvent ( QShowEvent *  )

overrideprotected

Definition at line 94 of file SimulationView.cpp.

{
    writeOptionsToUI();
}

References writeOptionsToUI().

Here is the call graph for this function:

simulate()

void SimulationView::simulate

(

)

Definition at line 138 of file SimulationView.cpp.

{
    readOptionsFromUI();
    if (const QString msg = validateSimulationSetup(true); !msg.isEmpty()) {
        QMessageBox::warning(this, "Can't run the job",
                             "Can't run the job with current settings\n\n" + msg);
        return;
    }
    JobModel* jobModel = m_document->jobModel();
    JobItem* jobItem = jobModel->addJob(selectedSample(), selectedInstrument(), selectedRealData(),
                                        *optionsItem());
    jobModel->runJob(jobItem);
}

References JobModel::addJob(), ProjectDocument::jobModel(), m_document, optionsItem(), readOptionsFromUI(), JobModel::runJob(), selectedInstrument(), selectedRealData(), selectedSample(), validateSimulationSetup(), and GUI::View::Helpers::warning().

Referenced by SimulationView(), and MainWindow::onRunSimulationShortcut().

Here is the call graph for this function:

updateEnabling()

void SimulationView::updateEnabling ( )

private

Update enabling of elements depending on other elements.

Definition at line 179 of file SimulationView.cpp.

{
    m_ui->numberOfMonteCarloPoints->setEnabled(m_ui->monteCarloRadio->isChecked());
}

References m_ui.

Referenced by SimulationView(), and writeOptionsToUI().

updateFunctionalityNarrowing()

void SimulationView::updateFunctionalityNarrowing ( )

private

Show/hide UI elements according to settings in current project.

Definition at line 227 of file SimulationView.cpp.

{
    m_ui->instrumentCombo->setVisible(!m_document->singleInstrumentMode());
    m_ui->instrumentLabel->setVisible(!m_document->singleInstrumentMode());
}

References m_document, m_ui, and ProjectDocument::singleInstrumentMode().

Referenced by SimulationView().

Here is the call graph for this function:

updateSelection()

void SimulationView::updateSelection ( QComboBox *  comboBox, QStringList  itemList, bool  allowNone = false  )

private

Updates selection combo with string list while preserving previous selection. If allowNone == true, additional "None" item will be added to the combo.

Definition at line 184 of file SimulationView.cpp.

{
    const QString previousItem = comboBox->currentText();
 
    comboBox->clear();
    comboBox->setEnabled(!itemList.isEmpty());
 
    if (itemList.isEmpty()) {
        comboBox->addItem("Not yet defined");
        return;
    }
 
    if (allowNone)
        itemList.insert(-1, "None");
    comboBox->addItems(itemList);
    if (itemList.contains(previousItem))
        comboBox->setCurrentIndex(itemList.indexOf(previousItem));
}

Referenced by writeOptionsToUI().

validateSimulationSetup()

QString SimulationView::validateSimulationSetup ( bool  validateRealData ) const

private

Checks whether selection is correct for running a simulation. Returns empty string if valid, otherwise the error text.

Definition at line 203 of file SimulationView.cpp.

{
    QString messages;
    const auto append = [&](const QString& m) { messages.append("- " + m + "\n"); };
 
    if (!selectedSample())
        append("No sample selected");
    else {
        SampleValidator sampleValidator;
        if (!sampleValidator.isValidMultiLayer(selectedSample()))
            append(sampleValidator.getValidationMessage());
    }
 
    if (!selectedInstrument())
        append("No instrument selected");
 
    if (validateRealData && selectedRealData() && selectedInstrument()
        && !selectedInstrument()->alignedWith(selectedRealData()))
        append("The experimental data does not fit in the selected instrument. Try linking "
               "them in Import Tab.");
 
    return messages;
}

References InstrumentItem::alignedWith(), SampleValidator::getValidationMessage(), SampleValidator::isValidMultiLayer(), selectedInstrument(), selectedRealData(), and selectedSample().

Referenced by exportPythonScript(), and simulate().

Here is the call graph for this function:

writeOptionsToUI()

void SimulationView::writeOptionsToUI ( )

private

Write entries in OptionsItem to UI.

Definition at line 99 of file SimulationView.cpp.

{
    QSignalBlocker b1(m_ui->runPolicyImmediatelyRadio);
    QSignalBlocker b2(m_ui->analyticalRadio);
    QSignalBlocker b3(m_ui->averageLayerRadio);
    QSignalBlocker b4(m_ui->numberOfThreadsCombo);
    QSignalBlocker b5(m_ui->numberOfMonteCarloPoints);
    QSignalBlocker b6(m_ui->includeSpecularCheck);
 
    // -- selection group
    updateSelection(m_ui->instrumentCombo, m_document->collectedItems()->instrumentNames());
    updateSelection(m_ui->sampleCombo, m_document->sampleItems()->sampleNames());
    updateSelection(m_ui->realDataCombo, m_document->realDataModel()->realDataNames(), true);
 
    // -- options group
    optionsItem()->runImmediately() ? m_ui->runPolicyImmediatelyRadio->setChecked(true)
                                    : m_ui->runPolicyBackgroundRadio->setChecked(true);
 
    optionsItem()->useAnalytical() ? m_ui->analyticalRadio->setChecked(true)
                                   : m_ui->monteCarloRadio->setChecked(true);
 
    optionsItem()->useAverageMaterials() ? m_ui->averageLayerRadio->setChecked(true)
                                         : m_ui->ambientLayerRadio->setChecked(true);
 
    m_ui->numberOfThreadsCombo->setCurrentIndex(
        m_ui->numberOfThreadsCombo->findData(optionsItem()->numberOfThreads()));
    m_ui->numberOfMonteCarloPoints->setValue(optionsItem()->numberOfMonteCarloPoints());
    m_ui->includeSpecularCheck->setChecked(optionsItem()->includeSpecularPeak());
 
    updateEnabling();
}

References ProjectDocument::collectedItems(), InstrumentCollection::instrumentNames(), m_document, m_ui, optionsItem(), ProjectDocument::realDataModel(), RealDataModel::realDataNames(), SimulationOptionsItem::runImmediately(), ProjectDocument::sampleItems(), MultiLayerItems::sampleNames(), updateEnabling(), updateSelection(), SimulationOptionsItem::useAnalytical(), and SimulationOptionsItem::useAverageMaterials().

Referenced by showEvent().

Here is the call graph for this function:

Member Data Documentation

m_document

ProjectDocument* SimulationView::m_document

private

Definition at line 92 of file SimulationView.h.

Referenced by SimulationView(), collectedItems(), optionsItem(), realDataItems(), sampleItems(), simulate(), updateFunctionalityNarrowing(), and writeOptionsToUI().

m_ui

Ui::SimulationView* SimulationView::m_ui

private

Definition at line 91 of file SimulationView.h.

Referenced by SimulationView(), readOptionsFromUI(), selectedInstrument(), selectedRealData(), selectedSample(), updateEnabling(), updateFunctionalityNarrowing(), and writeOptionsToUI().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Toplevel/SimulationView.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Toplevel/SimulationView.cpp