SimulationSetupAssistant Class Reference

The SimulationSetupAssistant class provides sample, instrument and real data validation before submitting the job. More...

Public Member Functions
	SimulationSetupAssistant ()
	Returns true if given setup is valid for submitting the job. More...
bool	isValidSimulationSetup (const MultiLayerItem *multiLayerItem, const InstrumentItem *instrumentItem, const RealDataItem *realData=0)

Private Member Functions
void	checkFittingSetup (const InstrumentItem *instrumentItem, const RealDataItem *realData)
	Check if setup is suitable for fitting. More...
void	checkInstrumentItem (const InstrumentItem *instrumentItem)
void	checkMultiLayerItem (const MultiLayerItem *multiLayerItem)
void	clear ()
QString	composeMessage ()
	Composes the error message for message box. More...

Private Attributes
bool	m_isValid
QStringList	m_messages

Detailed Description

The SimulationSetupAssistant class provides sample, instrument and real data validation before submitting the job.

Definition at line 27 of file SimulationSetupAssistant.h.

Constructor & Destructor Documentation

SimulationSetupAssistant()

SimulationSetupAssistant::SimulationSetupAssistant

(

)

Returns true if given setup is valid for submitting the job.

Definition at line 24 of file SimulationSetupAssistant.cpp.

: m_isValid(false) {}

Member Function Documentation

checkFittingSetup()

void SimulationSetupAssistant::checkFittingSetup ( const InstrumentItem *  instrumentItem, const RealDataItem *  realData  )

private

Check if setup is suitable for fitting.

In the case when there is a realData defined, its axes will be compared with current detector item.

Definition at line 74 of file SimulationSetupAssistant.cpp.

{
    if (!realData || !instrumentItem || instrumentItem->alignedWith(realData))
        return;
 
    m_isValid = false;
    m_messages.append("The experimental data does not fit in the selected instrument. Try linking "
                      "them in Import Tab.");
}

References InstrumentItem::alignedWith(), m_isValid, and m_messages.

Referenced by isValidSimulationSetup().

Here is the call graph for this function:

checkInstrumentItem()

void SimulationSetupAssistant::checkInstrumentItem ( const InstrumentItem *  instrumentItem )

private

Definition at line 63 of file SimulationSetupAssistant.cpp.

{
    if (!instrumentItem) {
        m_messages.append("No instrument selected");
        m_isValid = false;
    }
}

References m_isValid, and m_messages.

Referenced by isValidSimulationSetup().

checkMultiLayerItem()

void SimulationSetupAssistant::checkMultiLayerItem ( const MultiLayerItem *  multiLayerItem )

private

Definition at line 49 of file SimulationSetupAssistant.cpp.

{
    if (!multiLayerItem) {
        m_messages.append("No sample selected");
        m_isValid = false;
    } else {
        SampleValidator sampleValidator;
        if (!sampleValidator.isValidMultiLayer(multiLayerItem)) {
            m_isValid = false;
            m_messages.append(sampleValidator.getValidationMessage());
        }
    }
}

References SampleValidator::getValidationMessage(), SampleValidator::isValidMultiLayer(), m_isValid, and m_messages.

Referenced by isValidSimulationSetup().

Here is the call graph for this function:

clear()

void SimulationSetupAssistant::clear ( )

private

Definition at line 43 of file SimulationSetupAssistant.cpp.

{
    m_isValid = true;
    m_messages.clear();
}

References m_isValid, and m_messages.

Referenced by isValidSimulationSetup().

composeMessage()

QString SimulationSetupAssistant::composeMessage ( )

private

Composes the error message for message box.

Definition at line 87 of file SimulationSetupAssistant.cpp.

{
    QString result("Can't run the job with current settings\n\n");
    for (auto message : m_messages) {
        QString text = QString("- %1 \n").arg(message);
        result.append(text);
    }
    return result;
}

References m_messages.

Referenced by isValidSimulationSetup().

isValidSimulationSetup()

bool SimulationSetupAssistant::isValidSimulationSetup	(	const MultiLayerItem *	multiLayerItem,
		const InstrumentItem *	instrumentItem,
		const RealDataItem *	realData = 0
	)

Definition at line 26 of file SimulationSetupAssistant.cpp.

{
    clear();
 
    checkMultiLayerItem(multiLayerItem);
    checkInstrumentItem(instrumentItem);
    checkFittingSetup(instrumentItem, realData);
 
    if (!m_isValid)
        QMessageBox::warning(nullptr, "Can't run the job",
                             composeMessage()); // #baTODO fix modality
 
    return m_isValid;
}

References checkFittingSetup(), checkInstrumentItem(), checkMultiLayerItem(), clear(), composeMessage(), m_isValid, and GUIHelpers::warning().

Referenced by SimulationSetupWidget::onExportToPythonScript(), and SimulationSetupWidget::onRunSimulation().

Here is the call graph for this function:

Member Data Documentation

m_isValid

bool SimulationSetupAssistant::m_isValid

private

Definition at line 42 of file SimulationSetupAssistant.h.

Referenced by checkFittingSetup(), checkInstrumentItem(), checkMultiLayerItem(), clear(), and isValidSimulationSetup().

m_messages

QStringList SimulationSetupAssistant::m_messages

private

Definition at line 43 of file SimulationSetupAssistant.h.

Referenced by checkFittingSetup(), checkInstrumentItem(), checkMultiLayerItem(), clear(), and composeMessage().

---

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

• /home/www/ba/GUI/coregui/Views/SimulationWidgets/SimulationSetupAssistant.h
• /home/www/ba/GUI/coregui/Views/SimulationWidgets/SimulationSetupAssistant.cpp