Serialize Namespace Reference

Description

Functions to serialize various data types.

Serialization means writing to or reading from an XML stream.

This namespace is spread over several source files in order to keep include dependencies unidirectional.

Functions
template<typename BaseClass >
void	rwBaseClass (Streamer &s, const QString &tag, BaseClass *p)
	Serializes part of an items that belongs to a given base class. More...
template<typename Catalog , typename... Args>
void	rwCatalogized (Streamer &s, const QString &tag, QVector< typename Catalog::CatalogedType * > &vec, Args... argsForConstructor)
	Serializes a list of items from a class hierarchy described by a catalog. Passes optional arguments to the constructor. More...
template<typename T >
void	rwClass (Streamer &s, const QString &tag, T &t)
	Serializes an item from a class that provides the function void serialize(Streamer&). More...
template<typename ItemClass >
void	rwInitializable (Streamer &s, const QString &tag, std::unique_ptr< ItemClass > &up, const std::function< void(ItemClass *)> &initializer)
	Serializes an optional item of known type that needs an initializer. More...
template<typename ItemClass , typename... ArgsForConstructor>
void	rwOptional (Streamer &s, const QString &tag, std::unique_ptr< ItemClass > &up, ArgsForConstructor... argsForConstructor)
	Serializes an optional item of known type. Passes optional arguments to the constructor. More...
void	rwProperty (Streamer &s, DoubleProperty &d)
void	rwProperty (Streamer &s, UIntProperty &d)
void	rwProperty (Streamer &s, VectorProperty &d)
template<typename Catalog , typename... ArgsForCreation>
void	rwSelected (Streamer &s, SelectionProperty< typename Catalog::CatalogedType * > &d, ArgsForCreation... argsForCreation)
	Serializes an item from a catalog. Passes optional arguments to the constructor. More...
template<typename type >
void	rwSessionItem (Streamer &s, const QString &tag, SessionItem *property)
	Only for migration. More...
void	rwValue (Streamer &s, const QString &tag, bool &val)
void	rwValue (Streamer &s, const QString &tag, double &val)
void	rwValue (Streamer &s, const QString &tag, int &val)
void	rwValue (Streamer &s, const QString &tag, QByteArray &val)
void	rwValue (Streamer &s, const QString &tag, QColor &col)
void	rwValue (Streamer &s, const QString &tag, QString &val)
void	rwValue (Streamer &s, const QString &tag, R3 &val)
template<typename T , typename... Args>
void	rwVector (Streamer &s, const QString &tag, QVector< T > &vec, Args... argsForConstructor)
	Serializes a list of items of known and fixed type. Passes optional arguments to the constructor. More...

Function Documentation

rwBaseClass()

template<typename BaseClass >

void Serialize::rwBaseClass	(	Streamer &	s,
		const QString &	tag,
		BaseClass *	p
	)

Serializes part of an items that belongs to a given base class.

Definition at line 85 of file Serialize.h.

{
    s.start(tag);
    p->BaseClass::serialize(s);
    s.finish(tag);
}

References Streamer::finish(), and Streamer::start().

Here is the call graph for this function:

rwCatalogized()

template<typename Catalog , typename... Args>

void Serialize::rwCatalogized	(	Streamer &	s,
		const QString &	tag,
		QVector< typename Catalog::CatalogedType * > &	vec,
		Args...	argsForConstructor
	)

Serializes a list of items from a class hierarchy described by a catalog. Passes optional arguments to the constructor.

Definition at line 116 of file Serialize.h.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute("n", QString::number(vec.size()));
        int i = 0;
        for (auto* p : vec) {
            s.write<Catalog>("E" + QString::number(i++), p);
        }
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        const int n = r->attributes().value("n").toInt();
        for (int i = 0; i < n; i++) {
            typename Catalog::CatalogedType* p = nullptr;
            s.read<Catalog>("E" + QString::number(i), p, argsForConstructor...);
            vec << p;
        }
        s.gotoEndElementOfTag(tag);
    }
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), Streamer::read(), Streamer::write(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwClass()

template<typename T >

void Serialize::rwClass	(	Streamer &	s,
		const QString &	tag,
		T &	t
	)

Serializes an item from a class that provides the function void serialize(Streamer&).

Definition at line 77 of file Serialize.h.

{
    s.start(tag);
    t.serialize(s);
    s.finish(tag);
}

References Streamer::finish(), and Streamer::start().

Referenced by rwVector(), BeamItem::serialize(), InstrumentItem::serialize(), MultiLayerItem::serialize(), RectangularDetectorItem::serialize(), and SphericalDetectorItem::serialize().

Here is the call graph for this function:

rwInitializable()

template<typename ItemClass >

void Serialize::rwInitializable	(	Streamer &	s,
		const QString &	tag,
		std::unique_ptr< ItemClass > &	up,
		const std::function< void(ItemClass *)> &	initializer
	)

Serializes an optional item of known type that needs an initializer.

The initializer will be called after creation and before de-serialization

Definition at line 164 of file Serialize.h.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute("valid", up ? "1" : "0");
        if (up)
            up->serialize(s);
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        s.gotoStartElementOfTag(tag);
        const bool valid = r->attributes().value("valid").toUInt() > 0;
        if (valid) {
            up.reset(new ItemClass());
            if (initializer)
                initializer(up.get());
            up->serialize(s);
        } else
            up.reset();
        s.gotoEndElementOfTag(tag);
    }
}

References Streamer::gotoEndElementOfTag(), Streamer::gotoStartElementOfTag(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwOptional()

template<typename ItemClass , typename... ArgsForConstructor>

void Serialize::rwOptional	(	Streamer &	s,
		const QString &	tag,
		std::unique_ptr< ItemClass > &	up,
		ArgsForConstructor...	argsForConstructor
	)

Serializes an optional item of known type. Passes optional arguments to the constructor.

Definition at line 142 of file Serialize.h.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute("valid", up ? "1" : "0");
        if (up)
            up->serialize(s);
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        s.gotoStartElementOfTag(tag);
        const bool valid = r->attributes().value("valid").toUInt() > 0;
        if (valid) {
            up.reset(new ItemClass(argsForConstructor...));
            up->serialize(s);
        } else
            up.reset();
        s.gotoEndElementOfTag(tag);
    }
}

References Streamer::gotoEndElementOfTag(), Streamer::gotoStartElementOfTag(), Streamer::xmlReader(), and Streamer::xmlWriter().

Referenced by LayerItem::serialize(), and ParticleCoreShellItem::serialize().

Here is the call graph for this function:

rwProperty() [1/3]

void Serialize::rwProperty	(	Streamer &	s,
		DoubleProperty &	d
	)

Definition at line 65 of file DoubleProperty.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(d.persistentTag());
        GUI::Session::XML::writeAttribute(w, XML::Tags::Value, d.get());
        w->writeAttribute(XML::Tags::Id, d.uid());
        GUI::Session::XML::writeAttribute(w, XML::Tags::Decimals, d.decimals());
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(d.persistentTag());
        d.set(r->attributes().value(XML::Tags::Value).toDouble());
        d.setUid(r->attributes().value(XML::Tags::Id).toString());
        d.setDecimals(r->attributes().value(XML::Tags::Decimals).toUInt());
        s.gotoEndElementOfTag(d.persistentTag());
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), XML::Tags::Decimals(), DoubleProperty::decimals(), DoubleProperty::get(), Streamer::gotoEndElementOfTag(), XML::Tags::Id(), DoubleProperty::persistentTag(), DoubleProperty::set(), DoubleProperty::setDecimals(), DoubleProperty::setUid(), DoubleProperty::uid(), XML::Tags::Value(), GUI::Session::XML::writeAttribute(), Streamer::xmlReader(), and Streamer::xmlWriter().

Referenced by AxisProperty::rwAxisProperty(), DistributionItem::serialize(), BeamItem::serialize(), InstrumentItem::serialize(), FormFactorItem::serialize(), LayerItem::serialize(), LayerBasicRoughnessItem::serialize(), MultiLayerItem::serialize(), ParticleLayoutItem::serialize(), Profile1DItem::serialize(), Profile2DItem::serialize(), ConstantBackgroundItem::serialize(), FootprintGaussianItem::serialize(), FootprintSquareItem::serialize(), RectangularDetectorItem::serialize(), ResolutionFunction2DGaussianItem::serialize(), Interference1DLatticeItem::serialize(), Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), InterferenceHardDiskItem::serialize(), InterferenceRadialParaCrystalItem::serialize(), BasicLattice2DItem::serialize(), SquareLattice2DItem::serialize(), HexagonalLattice2DItem::serialize(), MesoCrystalItem::serialize(), ParticleCompositionItem::serialize(), ParticleCoreShellItem::serialize(), ParticleItem::serialize(), Profile1DVoigtItem::serialize(), Profile2DVoigtItem::serialize(), XRotationItem::serialize(), YRotationItem::serialize(), ZRotationItem::serialize(), EulerRotationItem::serialize(), and InterferenceItem::serialize().

Here is the call graph for this function:

rwProperty() [2/3]

void Serialize::rwProperty	(	Streamer &	s,
		UIntProperty &	d
	)

Definition at line 44 of file UIntProperty.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(d.persistentTag());
        GUI::Session::XML::writeAttribute(w, XML::Tags::Value, d.get());
        GUI::Session::XML::writeUid(w, d.uid());
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(d.persistentTag());
        d.set(r->attributes().value(XML::Tags::Value).toUInt());
        d.setUid(r->attributes().value(XML::Tags::Id).toString());
        s.gotoEndElementOfTag(d.persistentTag());
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), UIntProperty::get(), Streamer::gotoEndElementOfTag(), XML::Tags::Id(), UIntProperty::persistentTag(), UIntProperty::set(), UIntProperty::setUid(), UIntProperty::uid(), XML::Tags::Value(), GUI::Session::XML::writeAttribute(), GUI::Session::XML::writeUid(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwProperty() [3/3]

void Serialize::rwProperty	(	Streamer &	s,
		VectorProperty &	d
	)

Definition at line 31 of file VectorProperty.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(d.persistentTag());
        GUI::Session::XML::writeAttribute(w, XML::Tags::Value, d.get());
        GUI::Session::XML::writeUid(w, d.uid());
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(d.persistentTag());
        R3 vec;
        QString uid;
        GUI::Session::XML::readAttribute(r, XML::Tags::Value, &vec);
        GUI::Session::XML::readAttribute(r, XML::Tags::Id, &uid);
        d.set(vec);
        d.setUid(uid);
        s.gotoEndElementOfTag(d.persistentTag());
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), VectorProperty::get(), Streamer::gotoEndElementOfTag(), XML::Tags::Id(), VectorProperty::persistentTag(), GUI::Session::XML::readAttribute(), VectorProperty::set(), VectorProperty::setUid(), VectorProperty::uid(), XML::Tags::Value(), GUI::Session::XML::writeAttribute(), GUI::Session::XML::writeUid(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwSelected()

template<typename Catalog , typename... ArgsForCreation>

void Serialize::rwSelected	(	Streamer &	s,
		SelectionProperty< typename Catalog::CatalogedType * > &	d,
		ArgsForCreation...	argsForCreation
	)

Serializes an item from a catalog. Passes optional arguments to the constructor.

Definition at line 206 of file SelectionProperty.h.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        typename Catalog::CatalogedType* p = d.get();
        s.write<Catalog>(d.persistentTag(), p);
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        typename Catalog::CatalogedType* p = nullptr;
        s.read<Catalog>(d.persistentTag(), p, argsForCreation...);
        d.set(p);
    }
}

References SelectionProperty< T >::get(), SelectionProperty< T >::persistentTag(), Streamer::read(), SelectionProperty< T >::set(), Streamer::write(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwSessionItem()

template<typename type >

void Serialize::rwSessionItem	(	Streamer &	s,
		const QString &	tag,
		SessionItem *	property
	)

Only for migration.

Definition at line 428 of file SessionItem.h.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        auto v = property->value().value<type>();
        Serialize::rwValue(s, tag, v);
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        type v;
        Serialize::rwValue(s, tag, v);
        property->setValue(v);
    }
}

References rwValue(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwValue() [1/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		bool &	val
	)

Definition at line 19 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute(XML::Tags::Value, val ? "1" : "0");
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        val = r->attributes().value(XML::Tags::Value).toUInt() > 0;
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), XML::Tags::Value(), Streamer::xmlReader(), and Streamer::xmlWriter().

Referenced by rwSessionItem(), InstrumentItem::serialize(), LayerItem::serialize(), MaterialItem::serialize(), MultiLayerItem::serialize(), PointwiseAxisItem::serialize(), RectangularDetectorItem::serialize(), SpecularBeamInclinationItem::serialize(), Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), and ParticleItem::serialize().

Here is the call graph for this function:

rwValue() [2/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		double &	val
	)

Definition at line 49 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        GUI::Session::XML::writeAttribute(w, XML::Tags::Value, val);
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        val = r->attributes().value(XML::Tags::Value).toDouble();
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), XML::Tags::Value(), GUI::Session::XML::writeAttribute(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwValue() [3/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		int &	val
	)

Definition at line 34 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute(XML::Tags::Value, QString::number(val));
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        val = r->attributes().value(XML::Tags::Value).toInt();
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), XML::Tags::Value(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwValue() [4/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		QByteArray &	val
	)

Definition at line 95 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeCharacters(val.toBase64());
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        QString valueAsBase64 = r->readElementText(QXmlStreamReader::SkipChildElements);
        val = QByteArray::fromBase64(valueAsBase64.toLatin1());
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwValue() [5/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		QColor &	col
	)

Definition at line 79 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute(XML::Tags::Value, col.isValid() ? col.name(QColor::HexArgb) : "");
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        QString colName = r->attributes().value(XML::Tags::Value).toString();
        col = QColor(colName);
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), XML::Tags::Value(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwValue() [6/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		QString &	val
	)

Definition at line 64 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute(XML::Tags::Value, val);
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        GUI::Session::XML::readAttribute(r, XML::Tags::Value, &val);
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), GUI::Session::XML::readAttribute(), XML::Tags::Value(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwValue() [7/7]

void Serialize::rwValue	(	Streamer &	s,
		const QString &	tag,
		R3 &	val
	)

Definition at line 111 of file Serialize.cpp.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        GUI::Session::XML::writeAttribute(w, XML::Tags::Value, val);
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        s.gotoStartElementOfTag(tag);
        GUI::Session::XML::readAttribute(r, XML::Tags::Value, &val);
        s.gotoEndElementOfTag(tag);
    } else
        ASSERT(0);
}

References Streamer::gotoEndElementOfTag(), Streamer::gotoStartElementOfTag(), GUI::Session::XML::readAttribute(), XML::Tags::Value(), GUI::Session::XML::writeAttribute(), Streamer::xmlReader(), and Streamer::xmlWriter().

Here is the call graph for this function:

rwVector()

template<typename T , typename... Args>

void Serialize::rwVector	(	Streamer &	s,
		const QString &	tag,
		QVector< T > &	vec,
		Args...	argsForConstructor
	)

Serializes a list of items of known and fixed type. Passes optional arguments to the constructor.

Definition at line 93 of file Serialize.h.

{
    if (QXmlStreamWriter* w = s.xmlWriter()) {
        w->writeStartElement(tag);
        w->writeAttribute("n", QString::number(vec.size()));
        int i = 0;
        for (auto* p : vec)
            Serialize::rwClass(s, "E" + QString::number(i++), *p);
        w->writeEndElement();
    } else if (QXmlStreamReader* r = s.xmlReader()) {
        r->readNextStartElement();
        s.assertCurrentTag(tag);
        const int n = r->attributes().value("n").toInt();
        for (int i = 0; i < n; i++) {
            vec << new typename std::remove_pointer<T>::type(argsForConstructor...);
            Serialize::rwClass(s, "E" + QString::number(i), *vec.last());
        }
        s.gotoEndElementOfTag(tag);
    }
}

References Streamer::assertCurrentTag(), Streamer::gotoEndElementOfTag(), rwClass(), Streamer::xmlReader(), and Streamer::xmlWriter().

Referenced by LayerItem::serialize(), MaterialItems::serialize(), MultiLayerItem::serialize(), MultiLayerItems::serialize(), and PolygonItem::serialize().

Here is the call graph for this function: