SampleValidator.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/coregui/Models/SampleValidator.cpp
//! @brief     Implements class SampleValidator
//!
//! @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)
//
//  ************************************************************************************************
 
#include "GUI/coregui/Models/SampleValidator.h"
#include "GUI/coregui/Models/LayerItem.h"
#include "GUI/coregui/Models/MultiLayerItem.h"
#include "GUI/coregui/Models/ParticleCompositionItem.h"
#include "GUI/coregui/Models/ParticleCoreShellItem.h"
#include "GUI/coregui/Models/ParticleDistributionItem.h"
#include "GUI/coregui/Models/ParticleLayoutItem.h"
 
SampleValidator::SampleValidator() : m_valid_sample(true) {}
 
void SampleValidator::initValidator()
{
    m_validation_message.clear();
    m_valid_sample = true;
}
 
void SampleValidator::iterateItems(const SessionItem* parentItem)
{
    for (const SessionItem* child : parentItem->children()) {
        validateItem(child);
        iterateItems(child);
    }
}
 
void SampleValidator::validateItem(const SessionItem* item)
{
    if (!item)
        return;
 
    QString diagnosis;
 
    if (item->modelType() == "MultiLayer") {
        diagnosis = validateMultiLayerItem(item);
    } else if (item->modelType() == "ParticleLayout") {
        diagnosis = validateParticleLayoutItem(item);
    } else if (item->modelType() == "ParticleCoreShell") {
        diagnosis = validateParticleCoreShellItem(item);
    } else if (item->modelType() == "ParticleComposition") {
        diagnosis = validateParticleCompositionItem(item);
    } else if (item->modelType() == "ParticleDistribution") {
        diagnosis = validateParticleDistributionItem(item);
    }
    if (!diagnosis.isEmpty()) {
        m_valid_sample = false;
        m_validation_message += QString("* ") + diagnosis + "\n";
    }
}
 
QString SampleValidator::validateMultiLayerItem(const SessionItem* item)
{
    QString result;
 
    QVector<SessionItem*> layers = item->getItems(MultiLayerItem::T_LAYERS);
 
    if (layers.isEmpty()) {
        result = "MultiLayer should contain at least one layer.";
    } else if (layers.size() == 1) {
        if (layers.front()->getItems(LayerItem::T_LAYOUTS).isEmpty()) {
            result = "The single layer in your MultiLayer should contain ParticleLayout.";
        }
    }
    return result;
}
 
QString SampleValidator::validateParticleLayoutItem(const SessionItem* item)
{
    QString result;
 
    QVector<SessionItem*> particles = item->getItems(ParticleLayoutItem::T_PARTICLES);
    if (particles.isEmpty())
        result = "ParticleLayout doesn't contain any particles.";
 
    return result;
}
 
QString SampleValidator::validateParticleCoreShellItem(const SessionItem* item)
{
    QString result;
 
    const SessionItem* core = item->getItem(ParticleCoreShellItem::T_CORE);
    const SessionItem* shell = item->getItem(ParticleCoreShellItem::T_SHELL);
 
    if (core == nullptr || shell == nullptr)
        result = "ParticleCoreShell doesn't have either core or shell defined.";
 
    return result;
}
 
QString SampleValidator::validateParticleCompositionItem(const SessionItem* item)
{
    QString result;
    if (item->getItems(ParticleCompositionItem::T_PARTICLES).isEmpty())
        result = "ParticleComposition doesn't have any particles.";
 
    return result;
}
 
QString SampleValidator::validateParticleDistributionItem(const SessionItem* item)
{
    QString result;
    if (item->getItems(ParticleDistributionItem::T_PARTICLES).isEmpty())
        result = "ParticleDistribution doesn't have any particle.";
 
    return result;
}
 
bool SampleValidator::isValidMultiLayer(const MultiLayerItem* multilayer)
{
    initValidator();
 
    validateItem(multilayer);
    iterateItems(multilayer);
 
    if (!m_valid_sample) {
        m_validation_message =
            "Can't setup DWBA simulation for given MultiLayer.\n" + m_validation_message;
    }
    return m_valid_sample;
}