InstrumentLibrary.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Device/InstrumentLibrary.cpp
//! @brief     Implements class InstrumentLibrary
//!
//! @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/Model/Device/InstrumentLibrary.h"
#include "GUI/Model/Device/InstrumentItems.h"
#include "GUI/Support/XML/Serialize.h"
#include "GUI/Util/DeserializationException.h"
#include "GUI/Util/Path.h"
#include <QFile>
#include <QXmlStreamWriter>
 
namespace {
 
const QString XML_ROOT_TAG = "BornAgainInstrumentLibrary";
const QString XML_VERSION_TAG = "Version";
 
QString instrumentLibraryFilePath()
{
    return GUI::Util::Path::appDataFolder() + "/BornAgainInstrumentLibrary.balib";
}
 
} // namespace
 
 
InstrumentLibrary::InstrumentLibrary()
    : m_ec(&m_instrumentItems)
    , m_modified(false)
{
    QObject::connect(&m_ec, &InstrumentsEditController::instrumentChanged,
                     [&]() { m_modified = true; });
    QObject::connect(&m_ec, &InstrumentsEditController::instrumentAddedOrRemoved,
                     [&]() { m_modified = true; });
}
 
QString InstrumentLibrary::suggestName(const QString& name) const
{
    return m_instrumentItems.suggestInstrumentName(name);
}
 
InstrumentItem* InstrumentLibrary::add(const QString& name, const InstrumentItem& itemToCopy)
{
    return m_ec.addCopy(&itemToCopy, name);
}
 
bool InstrumentLibrary::isEmpty() const
{
    return m_instrumentItems.collectedItems().isEmpty();
}
 
QList<InstrumentItem*> InstrumentLibrary::collectedItems() const
{
    return m_instrumentItems.collectedItems().toList();
}
 
InstrumentsEditController* InstrumentLibrary::editController()
{
    return &m_ec;
}
 
bool InstrumentLibrary::saveIfModified()
{
    if (!m_modified)
        return true;
 
    QFile file(instrumentLibraryFilePath());
    if (!file.open(QFile::ReadWrite | QIODevice::Truncate | QFile::Text))
        return false;
 
    QXmlStreamWriter writer(&file);
    writer.setAutoFormatting(true);
    writer.writeStartDocument();
    writer.writeStartElement(XML_ROOT_TAG);
    writer.writeAttribute(XML_VERSION_TAG, "2");
 
    Streamer sInstruments(&writer);
    m_instrumentItems.serialize(sInstruments);
 
    writer.writeEndElement();
    writer.writeEndDocument();
 
    file.close();
    m_modified = false;
    return true;
}
 
bool InstrumentLibrary::load()
{
    m_modified = false;
    m_instrumentItems.clear();
 
    QFile file(instrumentLibraryFilePath());
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
        return false;
 
    try {
        QXmlStreamReader reader(&file);
 
        while (!reader.atEnd()) {
            reader.readNext();
            if (reader.isStartElement()) {
                if (reader.name() == XML_ROOT_TAG) {
                    const int foundVersion =
                        reader.attributes().value(XML_VERSION_TAG).toString().toInt();
                    if (foundVersion != 2)
                        return false;
 
                    Streamer sInstruments(&reader);
                    m_instrumentItems.serialize(sInstruments);
                }
            }
        }
 
        if (reader.hasError()) {
            m_instrumentItems.clear();
            return false;
        }
 
        file.close();
        return true;
    } catch (const std::exception&) {
        m_instrumentItems.clear();
        return false;
    } catch (const DeserializationException&) {
        m_instrumentItems.clear();
        return false;
    }
}
 
InstrumentCollection* InstrumentLibrary::collectedItems()
{
    return &m_instrumentItems;
}