Streamer Class Reference

Description

Supports serialization to or deserialization from QXmlStream.

Can be either a writer or a reader, depending on the constructor.

Definition at line 36 of file Streamer.h.

Public Member Functions
	Streamer (QXmlStreamReader *r)
	Streamer (QXmlStreamWriter *w)
void	assertCurrentTag (const QString &expectedTag) const
void	assertVersion (unsigned expectedVersion) const
	As reader, throws DeserializationException unless the expected version is read. As writer, does nothing. More...
void	finish (const QString &tag)
void	gotoEndElementOfTag (const QString &tag)
void	gotoStartElementOfTag (const QString &tag)
template<typename Catalog , typename... Args>
void	read (const QString &tag, typename Catalog::CatalogedType *&p, Args... argsForConstructor)
void	start (const QString &tag)
template<typename Catalog >
void	write (const QString &tag, typename Catalog::CatalogedType *p)
void	writeVersion (unsigned version) const
	As writer, serializes the given version number. As reader, does nothing. More...
QXmlStreamReader *	xmlReader ()
	Returns stream reader or nullptr. More...
QXmlStreamWriter *	xmlWriter ()
	Returns stream writer or nullptr. More...

Private Member Functions
void	assertCurrentToken (QXmlStreamReader::TokenType token) const

Private Attributes
QXmlStreamReader *	m_r = nullptr
QXmlStreamWriter *	m_w = nullptr

Constructor & Destructor Documentation

Streamer() [1/2]

Streamer::Streamer ( QXmlStreamWriter *  w )

inline

Definition at line 38 of file Streamer.h.

        : m_w(w)
    {
    }

Streamer() [2/2]

Streamer::Streamer ( QXmlStreamReader *  r )

inline

Definition at line 42 of file Streamer.h.

        : m_r(r)
    {
    }

Member Function Documentation

assertCurrentTag()

void Streamer::assertCurrentTag

(

const QString &

expectedTag

)

const

Definition at line 62 of file Streamer.cpp.

{
    ASSERT(m_r);
 
    if (m_r->name() != expectedTag) {
#ifdef _DEBUG
        // to simplify debugging: what is the current tag
        QString foundTag = m_r->name().toString();
        Q_UNUSED(foundTag);
#endif
        throw DeserializationException::streamError();
    }
}

References m_r, and DeserializationException::streamError().

Referenced by gotoEndElementOfTag(), Serialize::rwCatalogized(), Serialize::rwProperty(), Serialize::rwValue(), and Serialize::rwVector().

Here is the call graph for this function:

assertCurrentToken()

void Streamer::assertCurrentToken ( QXmlStreamReader::TokenType  token ) const

private

Definition at line 76 of file Streamer.cpp.

{
    if (m_r->tokenType() != token)
        throw DeserializationException::streamError();
}

References m_r, and DeserializationException::streamError().

Referenced by gotoEndElementOfTag(), and gotoStartElementOfTag().

Here is the call graph for this function:

assertVersion()

void Streamer::assertVersion

(

unsigned

expectedVersion

)

const

As reader, throws DeserializationException unless the expected version is read. As writer, does nothing.

Definition at line 26 of file Streamer.cpp.

{
    if (!m_r)
        return;
 
    const auto foundAsStr = m_r->attributes().value(XML::Tags::Version);
    const unsigned found = foundAsStr.isEmpty() ? 0 : foundAsStr.toUInt();
    if (found < expectedVersion)
        throw DeserializationException::tooOld();
    if (found > expectedVersion)
        throw DeserializationException::tooNew();
}

References m_r, DeserializationException::tooNew(), DeserializationException::tooOld(), and XML::Tags::Version().

Referenced by ProjectDocument::readProject(), AxisProperty::rwAxisProperty(), DistributionItem::serialize(), BasicAxisItem::serialize(), BeamItem::serialize(), InstrumentCollection::serialize(), InstrumentItem::serialize(), PolygonPointItem::serialize(), MaskItems::serialize(), FormFactorItem::serialize(), LayerItem::serialize(), LayerBasicRoughnessItem::serialize(), MaterialItem::serialize(), MaterialItems::serialize(), MultiLayerItem::serialize(), MultiLayerItems::serialize(), ParticleLayoutItem::serialize(), Profile1DItem::serialize(), Profile2DItem::serialize(), AmplitudeAxisItem::serialize(), ConstantBackgroundItem::serialize(), BeamAzimuthalAngleItem::serialize(), BeamInclinationAngleItem::serialize(), SpecularBeamItem::serialize(), BeamWavelengthItem::serialize(), FootprintGaussianItem::serialize(), FootprintSquareItem::serialize(), DepthProbeInstrumentItem::serialize(), Instrument2DItem::serialize(), OffspecInstrumentItem::serialize(), RectangleItem::serialize(), PolygonItem::serialize(), VerticalLineItem::serialize(), HorizontalLineItem::serialize(), EllipseItem::serialize(), MaskAllItem::serialize(), PointwiseAxisItem::serialize(), RectangularDetectorItem::serialize(), ResolutionFunction2DGaussianItem::serialize(), SpecularBeamInclinationItem::serialize(), SphericalDetectorItem::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:

finish()

void Streamer::finish

(

const QString &

tag

)

Definition at line 90 of file Streamer.cpp.

{
    if (m_w)
        m_w->writeEndElement();
    else
        gotoEndElementOfTag(tag);
}

References gotoEndElementOfTag(), and m_w.

Referenced by AxisProperty::rwAxisProperty(), Serialize::rwBaseClass(), and Serialize::rwClass().

Here is the call graph for this function:

gotoEndElementOfTag()

void Streamer::gotoEndElementOfTag

(

const QString &

tag

)

Definition at line 39 of file Streamer.cpp.

{
    if (m_r->name() != tag) {
        if (!m_r->isEndElement())
            m_r->skipCurrentElement();
        m_r->skipCurrentElement();
    }
    assertCurrentTag(tag);
    if (!m_r->isEndElement())
        m_r->skipCurrentElement();
 
    assertCurrentToken(QXmlStreamReader::EndElement);
    assertCurrentTag(tag);
}

References assertCurrentTag(), assertCurrentToken(), and m_r.

Referenced by finish(), read(), Serialize::rwCatalogized(), Serialize::rwInitializable(), Serialize::rwOptional(), Serialize::rwProperty(), Serialize::rwValue(), and Serialize::rwVector().

Here is the call graph for this function:

gotoStartElementOfTag()

void Streamer::gotoStartElementOfTag

(

const QString &

tag

)

Definition at line 54 of file Streamer.cpp.

{
    ASSERT(m_r);
    while (m_r->name() != tag && !m_r->hasError())
        m_r->readNextStartElement();
    assertCurrentToken(QXmlStreamReader::StartElement);
}

References assertCurrentToken(), and m_r.

Referenced by read(), Serialize::rwInitializable(), Serialize::rwOptional(), Serialize::rwValue(), and start().

Here is the call graph for this function:

read()

template<typename Catalog , typename... Args>

void Streamer::read	(	const QString &	tag,
		typename Catalog::CatalogedType *&	p,
		Args...	argsForConstructor
	)

Definition at line 93 of file Streamer.h.

{
    ASSERT(m_r);
    gotoStartElementOfTag(tag);
    const auto type = static_cast<typename Catalog::Type>(m_r->attributes().value("type").toUInt());
    p = Catalog::create(type, argsForConstructor...);
    if (p != nullptr)
        p->serialize(*this);
    gotoEndElementOfTag(tag);
}

References gotoEndElementOfTag(), gotoStartElementOfTag(), and m_r.

Referenced by JobItem::readNonSessionItems(), Serialize::rwCatalogized(), and Serialize::rwSelected().

Here is the call graph for this function:

start()

void Streamer::start

(

const QString &

tag

)

Definition at line 82 of file Streamer.cpp.

{
    if (m_w)
        m_w->writeStartElement(tag);
    else
        gotoStartElementOfTag(tag);
}

References gotoStartElementOfTag(), and m_w.

Referenced by AxisProperty::rwAxisProperty(), Serialize::rwBaseClass(), and Serialize::rwClass().

Here is the call graph for this function:

write()

template<typename Catalog >

void Streamer::write	(	const QString &	tag,
		typename Catalog::CatalogedType *	p
	)

Definition at line 82 of file Streamer.h.

{
    ASSERT(m_w);
    m_w->writeStartElement(tag);
    m_w->writeAttribute("type", QString::number(static_cast<uint8_t>(Catalog::type(p))));
    if (p != nullptr)
        p->serialize(*this);
    m_w->writeEndElement();
}

References m_w.

Referenced by Serialize::rwCatalogized(), Serialize::rwSelected(), and JobItem::writeNonSessionItems().

writeVersion()

void Streamer::writeVersion

(

unsigned

version

)

const

As writer, serializes the given version number. As reader, does nothing.

Definition at line 19 of file Streamer.cpp.

{
    if (!m_w)
        return;
    m_w->writeAttribute(XML::Tags::Version, QString::number(version));
}

References m_w, and XML::Tags::Version().

Referenced by ProjectDocument::writeTo().

Here is the call graph for this function:

xmlReader()

QXmlStreamReader* Streamer::xmlReader ( )

inline

Returns stream reader or nullptr.

Definition at line 48 of file Streamer.h.

References m_r.

Referenced by Serialize::rwCatalogized(), Serialize::rwInitializable(), Serialize::rwOptional(), Serialize::rwProperty(), Serialize::rwSelected(), Serialize::rwSessionItem(), Serialize::rwValue(), Serialize::rwVector(), MaskItems::serialize(), MaterialItem::serialize(), MaterialItems::serialize(), MultiLayerItem::serialize(), BeamAzimuthalAngleItem::serialize(), BeamInclinationAngleItem::serialize(), BeamWavelengthItem::serialize(), PolygonItem::serialize(), PointwiseAxisItem::serialize(), RectangularDetectorItem::serialize(), SpecularBeamInclinationItem::serialize(), and SphericalDetectorItem::serialize().

xmlWriter()

QXmlStreamWriter* Streamer::xmlWriter ( )

inline

Returns stream writer or nullptr.

Definition at line 47 of file Streamer.h.

References m_w.

Referenced by Serialize::rwCatalogized(), Serialize::rwInitializable(), Serialize::rwOptional(), Serialize::rwProperty(), Serialize::rwSelected(), Serialize::rwSessionItem(), Serialize::rwValue(), Serialize::rwVector(), and PointwiseAxisItem::serialize().

Member Data Documentation

m_r

QXmlStreamReader* Streamer::m_r = nullptr

private

Definition at line 74 of file Streamer.h.

Referenced by assertCurrentTag(), assertCurrentToken(), assertVersion(), gotoEndElementOfTag(), gotoStartElementOfTag(), read(), and xmlReader().

m_w

QXmlStreamWriter* Streamer::m_w = nullptr

private

Definition at line 73 of file Streamer.h.

Referenced by finish(), start(), write(), writeVersion(), and xmlWriter().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/XML/Streamer.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/XML/Streamer.cpp