SessionXML Namespace Reference

Functions
const QString	BinaryData ("BinaryData")
const QString	DisplayNameAttribute ("DisplayName")
const QString	DocumentModelTag ("DocumentModel")
const QString	ExternalPropertyColorAtt ("Color")
const QString	ExternalPropertyIdentifierAtt ("Identifier")
const QString	ExternalPropertyTextAtt ("Text")
const QString	InstrumentModelTag ("InstrumentModel")
const QString	ItemTag ("Item")
const QString	JobModelTag ("JobModel")
const QString	MaterialModelTag ("MaterialModel")
const QString	ModelNameAttribute ("Name")
const QString	ModelTypeAttribute ("ModelType")
const QString	ParameterExtAttribute ("ParExt")
const QString	ParameterNameAttribute ("ParName")
const QString	ParameterRoleAttribute ("ParRole")
const QString	ParameterTag ("Parameter")
const QString	ParameterTypeAttribute ("ParType")
const QString	ParameterValueAttribute ("ParValue")
void	readItems (QXmlStreamReader *reader, SessionItem *parent, QString topTag="", MessageService *messageService=nullptr)
QString	readProperty (QXmlStreamReader *reader, SessionItem *item, MessageService *messageService=nullptr)
const QString	RealDataModelTag ("RealDataModel")
const QString	SampleModelTag ("SampleModel")
const QString	TagAttribute ("Tag")
const QString	Version ("Version")
void	writeItemAndChildItems (QXmlStreamWriter *writer, const SessionItem *item)
void	writeTo (QXmlStreamWriter *writer, SessionItem *parent)
void	writeVariant (QXmlStreamWriter *writer, QVariant variant, int role)

Variables
const QString	ItemMimeType = "application/org.bornagainproject.xml.item.z"
const QString	LinkMimeType = "application/org.bornagainproject.fittinglink"

Function Documentation

BinaryData()

const QString SessionXML::BinaryData

(

"BinaryData"

)

Referenced by readItems(), and writeItemAndChildItems().

DisplayNameAttribute()

const QString SessionXML::DisplayNameAttribute

(

"DisplayName"

)

Referenced by readItems(), and writeItemAndChildItems().

DocumentModelTag()

const QString SessionXML::DocumentModelTag

(

"DocumentModel"

)

Referenced by DocumentModel::DocumentModel().

ExternalPropertyColorAtt()

const QString SessionXML::ExternalPropertyColorAtt

(

"Color"

)

Referenced by readProperty(), and writeVariant().

ExternalPropertyIdentifierAtt()

const QString SessionXML::ExternalPropertyIdentifierAtt

(

"Identifier"

)

Referenced by readProperty(), and writeVariant().

ExternalPropertyTextAtt()

const QString SessionXML::ExternalPropertyTextAtt

(

"Text"

)

Referenced by readProperty(), and writeVariant().

InstrumentModelTag()

const QString SessionXML::InstrumentModelTag

(

"InstrumentModel"

)

Referenced by InstrumentModel::InstrumentModel().

ItemTag()

const QString SessionXML::ItemTag

(

"Item"

)

Referenced by SessionModel::canDropMimeData(), ItemTreeView::dragMoveEvent(), readItems(), and writeItemAndChildItems().

JobModelTag()

const QString SessionXML::JobModelTag

(

"JobModel"

)

Referenced by JobModel::JobModel().

MaterialModelTag()

const QString SessionXML::MaterialModelTag

(

"MaterialModel"

)

Referenced by MaterialModel::MaterialModel().

ModelNameAttribute()

const QString SessionXML::ModelNameAttribute

(

"Name"

)

Referenced by SessionModel::readFrom(), and writeTo().

ModelTypeAttribute()

const QString SessionXML::ModelTypeAttribute

(

"ModelType"

)

Referenced by SessionModel::canDropMimeData(), ItemTreeView::dragMoveEvent(), readItems(), and writeItemAndChildItems().

ParameterExtAttribute()

const QString SessionXML::ParameterExtAttribute

(

"ParExt"

)

Referenced by readProperty(), and writeVariant().

ParameterNameAttribute()

const QString SessionXML::ParameterNameAttribute

(

"ParName"

)

Referenced by readProperty().

ParameterRoleAttribute()

const QString SessionXML::ParameterRoleAttribute

(

"ParRole"

)

Referenced by readProperty(), and writeVariant().

ParameterTag()

const QString SessionXML::ParameterTag

(

"Parameter"

)

Referenced by readItems(), and writeVariant().

ParameterTypeAttribute()

const QString SessionXML::ParameterTypeAttribute

(

"ParType"

)

Referenced by readProperty(), and writeVariant().

ParameterValueAttribute()

const QString SessionXML::ParameterValueAttribute

(

"ParValue"

)

Referenced by readProperty(), and writeVariant().

readItems()

void SessionXML::readItems	(	QXmlStreamReader *	reader,
		SessionItem *	parent,
		QString	topTag = "",
		MessageService *	messageService = nullptr
	)

Definition at line 122 of file SessionXML.cpp.

{
    ASSERT(parent);
    const QString start_type = parent->model()->getModelTag();
    while (!reader->atEnd()) {
        reader->readNext();
        if (reader->isStartElement()) {
            if (reader->name() == SessionXML::ItemTag) {
                const QString model_type =
                    reader->attributes().value(SessionXML::ModelTypeAttribute).toString();
                QString tag = reader->attributes().value(SessionXML::TagAttribute).toString();
                QString displayName =
                    reader->attributes().value(SessionXML::DisplayNameAttribute).toString();
 
                if (!topTag.isEmpty()) {
                    // to handle copying of item to another parent
                    tag = topTag;
                    topTag.clear();
                }
                auto newItem = createItem(parent, model_type, tag);
                if (!newItem) {
                    QString message = QString("Error while parsing XML. Can't create item of "
                                              "modelType '%1' for tag '%2', parent '%3'")
                                          .arg(model_type, tag, parent->P_NAME);
                    report_error(messageService, parent, message);
                    // risky attempt to recover the rest of the project
                    reader->skipCurrentElement();
                } else {
                    parent = newItem;
                    parent->setDisplayName(displayName);
                }
            } else if (reader->name() == SessionXML::ParameterTag) {
                SessionXML::readProperty(reader, parent, messageService);
            } else if (reader->name() == SessionXML::BinaryData) {
                if (reader->attributes().value(SessionXML::Version).toInt() == 1) {
                    QString valueAsBase64 =
                        reader->readElementText(QXmlStreamReader::SkipChildElements);
                    const auto data = QByteArray::fromBase64(
                        valueAsBase64.toLatin1()); // #baimport add a unit test for this!
                    parent->deserializeBinaryData(data);
                } else
                    throw DeserializationException::tooNew();
            }
        } else if (reader->isEndElement()) {
            if (reader->name() == SessionXML::ItemTag && parent)
                parent = parent->parent();
 
            if (reader->name() == start_type)
                break;
        }
    }
}

References ASSERT, BinaryData(), SessionItem::deserializeBinaryData(), DisplayNameAttribute(), SessionModel::getModelTag(), ItemTag(), SessionItem::model(), ModelTypeAttribute(), SessionItem::P_NAME, ParameterTag(), SessionItem::parent(), readProperty(), SessionItem::setDisplayName(), TagAttribute(), DeserializationException::tooNew(), and Version().

Referenced by SessionModel::copy(), SessionModel::load(), and SessionModel::readFrom().

Here is the call graph for this function:

readProperty()

QString SessionXML::readProperty	(	QXmlStreamReader *	reader,
		SessionItem *	item,
		MessageService *	messageService = nullptr
	)

Definition at line 176 of file SessionXML.cpp.

{
    const QString parameter_name =
        reader->attributes().value(SessionXML::ParameterNameAttribute).toString();
    const QString parameter_type =
        reader->attributes().value(SessionXML::ParameterTypeAttribute).toString();
    const int role = reader->attributes().value(SessionXML::ParameterRoleAttribute).toInt();
 
    if (!item) {
        QString message =
            QString("Attempt to set property '%1' for non existing item").arg(parameter_name);
        report_error(messageService, item, message);
        return parameter_name;
    }
 
    QVariant variant;
    if (parameter_type == double_type_name) {
        double parameter_value =
            reader->attributes().value(SessionXML::ParameterValueAttribute).toDouble();
        variant = parameter_value;
    } else if (parameter_type == int_type_name) {
        int parameter_value =
            reader->attributes().value(SessionXML::ParameterValueAttribute).toInt();
        variant = parameter_value;
    } else if (parameter_type == uint_type_name) {
        unsigned parameter_value =
            reader->attributes().value(SessionXML::ParameterValueAttribute).toUInt();
        variant = parameter_value;
    } else if (parameter_type == bool_type_name) {
        bool parameter_value =
            reader->attributes().value(SessionXML::ParameterValueAttribute).toInt();
        variant = parameter_value;
    } else if (parameter_type == qstring_type_name) {
        QString parameter_value =
            reader->attributes().value(SessionXML::ParameterValueAttribute).toString();
        variant = parameter_value;
    } else if (parameter_type == "ExternalProperty") {
        QString text = reader->attributes().value(SessionXML::ExternalPropertyTextAtt).toString();
        QString colorName =
            reader->attributes().value(SessionXML::ExternalPropertyColorAtt).toString();
        QString identifier =
            reader->attributes().value(SessionXML::ExternalPropertyIdentifierAtt).toString();
 
        ExternalProperty property;
        property.setText(text);
        property.setColor(QColor(colorName));
        property.setIdentifier(identifier);
        variant = property.variant();
    } else if (parameter_type == "ComboProperty") {
        QString selections =
            reader->attributes().value(SessionXML::ParameterValueAttribute).toString();
        QString values = reader->attributes().value(SessionXML::ParameterExtAttribute).toString();
 
        ComboProperty combo_property;
        combo_property.setStringOfValues(values);
        combo_property.setStringOfSelections(selections);
 
        variant = combo_property.variant();
    } else {
        QString message = QString("SessionModel::readProperty: parameter type not supported '"
                                  + parameter_type + "'");
        throw GUIHelpers::Error(message);
    }
 
    if (variant.isValid()) {
        item->setRoleProperty(role, variant);
    }
 
    return parameter_name;
}

References ModelView::Constants::bool_type_name, ModelView::Constants::double_type_name, ExternalPropertyColorAtt(), ExternalPropertyIdentifierAtt(), ExternalPropertyTextAtt(), ModelView::Constants::int_type_name, ParameterExtAttribute(), ParameterNameAttribute(), ParameterRoleAttribute(), ParameterTypeAttribute(), ParameterValueAttribute(), SessionItem::setRoleProperty(), ComboProperty::setStringOfSelections(), ComboProperty::setStringOfValues(), ExternalProperty::setText(), and ComboProperty::variant().

Referenced by readItems().

Here is the call graph for this function:

RealDataModelTag()

const QString SessionXML::RealDataModelTag

(

"RealDataModel"

)

Referenced by RealDataModel::RealDataModel().

SampleModelTag()

const QString SessionXML::SampleModelTag

(

"SampleModel"

)

Referenced by SampleModel::SampleModel().

TagAttribute()

const QString SessionXML::TagAttribute

(

"Tag"

)

Referenced by readItems(), and writeItemAndChildItems().

Version()

const QString SessionXML::Version

(

"Version"

)

Referenced by readItems(), and writeItemAndChildItems().

writeItemAndChildItems()

void SessionXML::writeItemAndChildItems	(	QXmlStreamWriter *	writer,
		const SessionItem *	item
	)

Definition at line 49 of file SessionXML.cpp.

{
    if (item->parent()) {
        writer->writeStartElement(SessionXML::ItemTag);
        writer->writeAttribute(SessionXML::ModelTypeAttribute, item->modelType());
        QString tag = item->parent()->tagFromItem(item);
        writer->writeAttribute(SessionXML::TagAttribute, tag);
        writer->writeAttribute(SessionXML::DisplayNameAttribute,
                               item->roleProperty(SessionFlags::DisplayNameRole).toString());
        for (int role : item->getRoles()) {
            if (role == Qt::DisplayRole || role == Qt::EditRole)
                SessionXML::writeVariant(writer, item->value(), role);
        }
    }
 
    for (auto child : item->children())
        writeItemAndChildItems(writer, child);
 
    QByteArray a = item->serializeBinaryData();
    if (!a.isEmpty()) {
        writer->writeStartElement(SessionXML::BinaryData);
        writer->writeAttribute(SessionXML::Version, "1");
        writer->writeCharacters(a.toBase64());
        writer->writeEndElement();
    }
 
    if (item->parent())
        writer->writeEndElement(); // ItemTag
}

References BinaryData(), SessionItem::children(), DisplayNameAttribute(), SessionFlags::DisplayNameRole, SessionItem::getRoles(), ItemTag(), SessionItem::modelType(), ModelTypeAttribute(), SessionItem::parent(), SessionItem::roleProperty(), SessionItem::serializeBinaryData(), TagAttribute(), SessionItem::tagFromItem(), SessionItem::value(), Version(), and writeVariant().

Referenced by SessionModel::copy(), SessionModel::mimeData(), SessionModel::save(), and writeTo().

Here is the call graph for this function:

writeTo()

void SessionXML::writeTo	(	QXmlStreamWriter *	writer,
		SessionItem *	parent
	)

Definition at line 39 of file SessionXML.cpp.

{
    writer->writeStartElement(parent->model()->getModelTag());
    writer->writeAttribute(SessionXML::ModelNameAttribute, parent->model()->getModelName());
 
    writeItemAndChildItems(writer, parent);
 
    writer->writeEndElement(); // m_model_tag
}

References SessionModel::getModelName(), SessionModel::getModelTag(), SessionItem::model(), ModelNameAttribute(), and writeItemAndChildItems().

Referenced by SessionModel::writeTo().

Here is the call graph for this function:

writeVariant()

void SessionXML::writeVariant	(	QXmlStreamWriter *	writer,
		QVariant	variant,
		int	role
	)

Definition at line 79 of file SessionXML.cpp.

{
    if (variant.isValid()) {
        writer->writeStartElement(SessionXML::ParameterTag);
        QString type_name = variant.typeName();
        writer->writeAttribute(SessionXML::ParameterTypeAttribute, type_name);
        writer->writeAttribute(SessionXML::ParameterRoleAttribute, QString::number(role));
 
        if (type_name == double_type_name) {
            writer->writeAttribute(SessionXML::ParameterValueAttribute,
                                   QString::number(variant.toDouble(), 'e', 12));
        } else if (type_name == int_type_name) {
            writer->writeAttribute(SessionXML::ParameterValueAttribute,
                                   QString::number(variant.toInt()));
        } else if (type_name == uint_type_name) {
            writer->writeAttribute(SessionXML::ParameterValueAttribute,
                                   QString::number(variant.toUInt()));
        } else if (type_name == bool_type_name) {
            writer->writeAttribute(SessionXML::ParameterValueAttribute,
                                   QString::number(variant.toBool()));
        } else if (type_name == qstring_type_name) {
            writer->writeAttribute(SessionXML::ParameterValueAttribute, variant.toString());
        } else if (type_name == "ExternalProperty") {
            ExternalProperty prop = variant.value<ExternalProperty>();
            writer->writeAttribute(SessionXML::ExternalPropertyTextAtt, prop.text());
 
            QString tcol = prop.color().isValid() ? prop.color().name(QColor::HexArgb) : "";
            writer->writeAttribute(SessionXML::ExternalPropertyColorAtt, tcol);
            writer->writeAttribute(SessionXML::ExternalPropertyIdentifierAtt, prop.identifier());
        } else if (type_name == "ComboProperty") {
            ComboProperty combo = variant.value<ComboProperty>();
            writer->writeAttribute(SessionXML::ParameterValueAttribute, combo.stringOfSelections());
            writer->writeAttribute(SessionXML::ParameterExtAttribute, combo.stringOfValues());
 
        } else {
            throw GUIHelpers::Error("SessionXML::writeVariant: Parameter type not supported "
                                    + type_name);
        }
 
        writer->writeEndElement(); // end ParameterTag
    }
}

References ModelView::Constants::bool_type_name, ExternalProperty::color(), ModelView::Constants::double_type_name, ExternalPropertyColorAtt(), ExternalPropertyIdentifierAtt(), ExternalPropertyTextAtt(), ExternalProperty::identifier(), ModelView::Constants::int_type_name, ParameterExtAttribute(), ParameterRoleAttribute(), ParameterTag(), ParameterTypeAttribute(), ParameterValueAttribute(), ComboProperty::stringOfSelections(), ComboProperty::stringOfValues(), and ExternalProperty::text().

Referenced by writeItemAndChildItems().

Here is the call graph for this function:

Variable Documentation

ItemMimeType

const QString SessionXML::ItemMimeType = "application/org.bornagainproject.xml.item.z"

Definition at line 26 of file SessionXML.h.

Referenced by SessionModel::canDropMimeData(), ItemTreeView::dragMoveEvent(), SessionModel::dropMimeData(), SessionModel::mimeData(), and SessionModel::mimeTypes().

LinkMimeType

const QString SessionXML::LinkMimeType = "application/org.bornagainproject.fittinglink"

Definition at line 27 of file SessionXML.h.

Referenced by FitParameterProxyModel::dropMimeData(), FitParameterProxyModel::mimeData(), ParameterTuningModel::mimeData(), and FitParameterProxyModel::mimeTypes().