SessionXML.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/coregui/Models/SessionXML.h
//! @brief     Defines reader and writer classes for SessionModel
//!
//! @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_MODELS_SESSIONXML_H
#define BORNAGAIN_GUI_COREGUI_MODELS_SESSIONXML_H
 
#include <QVariant>
 
class QXmlStreamWriter;
class QXmlStreamReader;
class SessionItem;
class MessageService;
 
namespace SessionXML {
const QString ItemMimeType = "application/org.bornagainproject.xml.item.z";
const QString LinkMimeType = "application/org.bornagainproject.fittinglink";
 
const QString InstrumentModelTag("InstrumentModel");
const QString SampleModelTag("SampleModel");
const QString MaterialModelTag("MaterialModel");
const QString JobModelTag("JobModel");
const QString DocumentModelTag("DocumentModel");
const QString RealDataModelTag("RealDataModel");
 
const QString TagAttribute("Tag");
 
const QString ModelNameAttribute("Name");
const QString ItemTag("Item");
const QString ModelTypeAttribute("ModelType");
const QString DisplayNameAttribute("DisplayName");
const QString ParameterTag("Parameter");
const QString BinaryData("BinaryData");
const QString Version("Version");
const QString ParameterNameAttribute("ParName");
const QString ParameterTypeAttribute("ParType");
const QString ParameterValueAttribute("ParValue");
const QString ParameterRoleAttribute("ParRole");
const QString ParameterExtAttribute("ParExt");
 
const QString ExternalPropertyTextAtt("Text");
const QString ExternalPropertyColorAtt("Color");
const QString ExternalPropertyIdentifierAtt("Identifier");
 
void writeTo(QXmlStreamWriter* writer, SessionItem* parent);
void writeItemAndChildItems(QXmlStreamWriter* writer, const SessionItem* item);
void writeVariant(QXmlStreamWriter* writer, QVariant variant, int role);
 
void readItems(QXmlStreamReader* reader, SessionItem* parent, QString topTag = "",
               MessageService* messageService = nullptr);
QString readProperty(QXmlStreamReader* reader, SessionItem* item,
                     MessageService* messageService = nullptr);
} // namespace SessionXML
 
#endif // BORNAGAIN_GUI_COREGUI_MODELS_SESSIONXML_H