MaterialItem Class Reference

Description

Definition at line 32 of file MaterialItem.h.

Inheritance diagram for MaterialItem:

Collaboration diagram for MaterialItem:

Classes
struct	Refractive

Signals
void	dataChanged () const

Public Member Functions
	MaterialItem ()
	MaterialItem (const MaterialItem &other)
	Creates a complete copy, also the identifier is the same. More...
DoubleDescriptor	beta ()
QColor	color () const
std::unique_ptr< Material >	createMaterial () const
void	createNewIdentifier ()
DoubleDescriptor	delta ()
bool	hasRefractiveIndex () const
QString	identifier () const
R3	magnetization () const
VectorDescriptor	magnetizationVector ()
QString	matItemName () const
bool	operator!= (const MaterialItem &other) const
bool	operator== (const MaterialItem &other) const
	Compares all contents. The inactive contents (e.g. SLD in case of refractive) are not taken into account. More...
void	readContentFrom (QXmlStreamReader *reader)
void	serialize (Streamer &s)
void	setColor (const QColor &color)
void	setIdentifier (const QString &id)
void	setMagnetization (const R3 &magnetization)
void	setMatItemName (const QString &name)
void	setRefractiveIndex (double delta, double beta)
	Turns material into refractive index material. More...
void	setScatteringLengthDensity (complex_t sld)
	Turns material into SLD based material. More...
DoubleDescriptor	sldIm ()
DoubleDescriptor	sldRe ()
void	updateFrom (const MaterialItem &other)
	Updates content from the other material. More...
void	writeContentTo (QXmlStreamWriter *writer) const

Private Member Functions
QString	uidForDescriptor (const QString &lastPart) const
	Returns a unique identifier for descriptors. More...

Private Attributes
QColor	m_color
std::variant< Refractive, complex_t >	m_data
QString	m_id
R3	m_magnetization
QString	m_name

Constructor & Destructor Documentation

MaterialItem() [1/2]

MaterialItem::MaterialItem

(

)

Definition at line 48 of file MaterialItem.cpp.

    : m_data(Refractive(0.0, 0.0))
{
    m_color = Qt::red;
    m_id = QUuid::createUuid().toString();
}

References m_color, and m_id.

MaterialItem() [2/2]

MaterialItem::MaterialItem

(

const MaterialItem &

other

)

Creates a complete copy, also the identifier is the same.

Note that the base QObject is freshly initialized, not copied from other. Therefore object hierarchy, connections, properties, object name or similar things are not copied. This is of no harm since this class is only derived from QObject to provide data change signaling.

Definition at line 55 of file MaterialItem.cpp.

    : QObject()
    , m_name(other.m_name)
    , m_id(other.m_id)
    , m_color(other.m_color)
    , m_data(other.m_data)
    , m_magnetization(other.m_magnetization)
{
}

References other.

Member Function Documentation

beta()

DoubleDescriptor MaterialItem::beta

(

)

Definition at line 101 of file MaterialItem.cpp.

{
    ASSERT(hasRefractiveIndex());
    const auto setter = [=](double v) {
        if (m_beta != v) {
            m_beta = v;
            emit dataChanged();
        }
    };
 
    DoubleDescriptor d(
        "Beta", "Beta of refractive index (n = 1 - delta + i*beta)", 3, RealLimits::limitless(),
        setter, [=] { return m_beta; }, Unit::unitless);
    d.path = [=] { return uidForDescriptor("beta"); };
    return d;
}

References dataChanged(), hasRefractiveIndex(), m_beta, DoubleDescriptor::path, uidForDescriptor(), and unitless.

Referenced by MaterialEditorModel::data(), serialize(), and setRefractiveIndex().

Here is the call graph for this function:

color()

QColor MaterialItem::color

(

)

const

Definition at line 221 of file MaterialItem.cpp.

{
    return m_color;
}

References m_color.

Referenced by ItemWithMaterial::materialColor(), setColor(), and RealSpaceCanvas::updateScene().

createMaterial()

std::unique_ptr< Material > MaterialItem::createMaterial

(

)

const

Definition at line 247 of file MaterialItem.cpp.

{
    if (hasRefractiveIndex())
        return std::make_unique<Material>(
            RefractiveMaterial(matItemName().toStdString(), m_delta, m_beta, m_magnetization));
 
    return std::make_unique<Material>(
        MaterialBySLD(matItemName().toStdString(), m_real, m_imag, m_magnetization));
}

References hasRefractiveIndex(), m_beta, m_delta, m_imag, m_magnetization, m_real, and matItemName().

Referenced by ParticleItem::createParticle().

Here is the call graph for this function:

createNewIdentifier()

void MaterialItem::createNewIdentifier

(

)

Definition at line 215 of file MaterialItem.cpp.

{
    m_id = QUuid::createUuid().toString();
    // no "emit dataChanged()" here
}

References m_id.

dataChanged

void MaterialItem::dataChanged ( ) const

signal

Referenced by MaterialInplaceForm::MaterialInplaceForm(), MaterialItems::addMaterial(), beta(), delta(), magnetizationVector(), MaterialInplaceForm::selectMaterial(), setColor(), setMagnetization(), setMatItemName(), setRefractiveIndex(), setScatteringLengthDensity(), sldIm(), sldRe(), and updateFrom().

delta()

DoubleDescriptor MaterialItem::delta

(

)

Definition at line 84 of file MaterialItem.cpp.

{
    ASSERT(hasRefractiveIndex());
    const auto setter = [=](double v) {
        if (m_delta != v) {
            m_delta = v;
            emit dataChanged();
        }
    };
 
    DoubleDescriptor d(
        "Delta", "Delta of refractive index (n = 1 - delta + i*beta)", 3, RealLimits::limitless(),
        setter, [=] { return m_delta; }, Unit::unitless);
    d.path = [=] { return uidForDescriptor("delta"); };
    return d;
}

References dataChanged(), hasRefractiveIndex(), m_delta, DoubleDescriptor::path, uidForDescriptor(), and unitless.

Referenced by MaterialEditorModel::data(), serialize(), and setRefractiveIndex().

Here is the call graph for this function:

hasRefractiveIndex()

bool MaterialItem::hasRefractiveIndex

(

)

const

Returns

true if refractive index was given, otherwise SLD was given

Definition at line 186 of file MaterialItem.cpp.

{
    return std::holds_alternative<Refractive>(m_data);
}

References m_data.

Referenced by beta(), createMaterial(), MaterialEditorModel::data(), delta(), operator==(), serialize(), setRefractiveIndex(), setScatteringLengthDensity(), sldIm(), sldRe(), and writeContentTo().

identifier()

QString MaterialItem::identifier

(

)

const

Definition at line 204 of file MaterialItem.cpp.

{
    return m_id;
}

References m_id.

Referenced by MaterialEditorDialog::removeCurrentMaterial(), ItemWithMaterial::setMaterial(), and uidForDescriptor().

magnetization()

R3 MaterialItem::magnetization

(

)

const

Definition at line 234 of file MaterialItem.cpp.

{
    return m_magnetization;
}

References m_magnetization.

Referenced by MaterialEditorModel::data(), and setMagnetization().

magnetizationVector()

VectorDescriptor MaterialItem::magnetizationVector

(

)

Definition at line 152 of file MaterialItem.cpp.

{
    VectorDescriptor d("Magnetization", "Magnetization (A/m)", "A/m");
 
    d.x.set = [=](double v) {
        if (m_magnetization.x() != v) {
            m_magnetization.setX(v);
            emit dataChanged();
        }
    };
    d.x.get = [=]() { return m_magnetization.x(); };
    d.x.path = [=] { return uidForDescriptor("mx"); };
 
    d.y.set = [=](double v) {
        if (m_magnetization.y() != v) {
            m_magnetization.setY(v);
            emit dataChanged();
        }
    };
    d.y.get = [=]() { return m_magnetization.y(); };
    d.y.path = [=] { return uidForDescriptor("my"); };
 
    d.z.set = [=](double v) {
        if (m_magnetization.z() != v) {
            m_magnetization.setZ(v);
            emit dataChanged();
        }
    };
    d.z.get = [=]() { return m_magnetization.z(); };
    d.z.path = [=] { return uidForDescriptor("mz"); };
    d.uid = [=] { return uidForDescriptor("magnetization"); };
    return d;
}

References dataChanged(), DoubleDescriptor::get, m_magnetization, DoubleDescriptor::path, DoubleDescriptor::set, VectorDescriptor::uid, uidForDescriptor(), VectorDescriptor::x, VectorDescriptor::y, and VectorDescriptor::z.

Here is the call graph for this function:

matItemName()

QString MaterialItem::matItemName

(

)

const

Definition at line 191 of file MaterialItem.cpp.

{
    return m_name;
}

References m_name.

Referenced by createMaterial(), MaterialEditorModel::data(), MaterialItems::insertCopy(), and ItemWithMaterial::materialName().

operator!=()

bool MaterialItem::operator!=

(

const MaterialItem &

other

)

const

Definition at line 338 of file MaterialItem.cpp.

{
    return !operator==(other);
}

References operator==(), and other.

Here is the call graph for this function:

operator==()

bool MaterialItem::operator==

(

const MaterialItem &

other

)

const

Compares all contents. The inactive contents (e.g. SLD in case of refractive) are not taken into account.

Definition at line 343 of file MaterialItem.cpp.

{
    if (hasRefractiveIndex()) {
        if (std::get<Refractive>(m_data) != std::get<Refractive>(other.m_data))
            return false;
    } else if (std::get<complex_t>(m_data) != std::get<complex_t>(other.m_data))
        return false;
 
 
    return (m_id == other.m_id) && (m_name == other.m_name) && (m_color == other.m_color)
           && (m_magnetization == other.m_magnetization);
}

References hasRefractiveIndex(), m_color, m_data, m_id, m_magnetization, m_name, and other.

Referenced by operator!=().

Here is the call graph for this function:

readContentFrom()

void MaterialItem::readContentFrom

(

QXmlStreamReader *

reader

)

Definition at line 273 of file MaterialItem.cpp.

{
    const int version = reader->attributes().value(GUI::Session::XML::Version).toInt();
 
    if (version < 1)
        throw DeserializationException::tooOld();
 
    if (version > 1)
        throw DeserializationException::tooNew();
 
    GUI::Session::XML::readAttribute(reader, Tags::Id, &m_id);
    GUI::Session::XML::readAttribute(reader, Tags::Color, &m_color);
    GUI::Session::XML::readAttribute(reader, Tags::Name, &m_name);
    GUI::Session::XML::readAttribute(reader, Tags::Magnetization, &m_magnetization);
    if (reader->attributes().hasAttribute(Tags::Delta)) {
        double d, b;
        GUI::Session::XML::readAttribute(reader, Tags::Delta, &d);
        GUI::Session::XML::readAttribute(reader, Tags::Beta, &b);
        m_data = Refractive(d, b);
    } else {
        complex_t c;
        GUI::Session::XML::readAttribute(reader, Tags::Sld, &c);
        m_data = c;
    }
}

References XML::Tags::Id(), m_color, m_data, m_id, m_magnetization, m_name, GUI::Session::XML::readAttribute(), DeserializationException::tooNew(), DeserializationException::tooOld(), and GUI::Session::XML::Version().

Here is the call graph for this function:

serialize()

void MaterialItem::serialize

(

Streamer &

s

)

Definition at line 299 of file MaterialItem.cpp.

{
    bool hasRefractive = hasRefractiveIndex();
    double val1 = hasRefractiveIndex() ? delta() : sldRe();
    double val2 = hasRefractiveIndex() ? beta() : sldIm();
 
    s.assertVersion(0);
    Serialize::rwValue(s, "name", m_name);
    Serialize::rwValue(s, "id", m_id);
    Serialize::rwValue(s, "color", m_color);
    Serialize::rwValue(s, "magnetization", m_magnetization);
    Serialize::rwValue(s, "refr", hasRefractive);
    Serialize::rwValue(s, "val1", val1);
    Serialize::rwValue(s, "val2", val2);
 
    if (s.xmlReader()) {
        if (hasRefractive)
            m_data = Refractive(val1, val2);
        else
            m_data = complex_t(val1, val2);
    }
}

References Streamer::assertVersion(), beta(), delta(), hasRefractiveIndex(), m_color, m_data, m_id, m_magnetization, m_name, Serialize::rwValue(), sldIm(), sldRe(), and Streamer::xmlReader().

Here is the call graph for this function:

setColor()

void MaterialItem::setColor

(

const QColor &

color

)

Definition at line 226 of file MaterialItem.cpp.

{
    if (m_color != color) {
        m_color = color;
        emit dataChanged();
    }
}

References color(), dataChanged(), and m_color.

Referenced by MaterialEditorModel::setColor().

Here is the call graph for this function:

setIdentifier()

void MaterialItem::setIdentifier

(

const QString &

id

)

Definition at line 209 of file MaterialItem.cpp.

{
    m_id = id;
    // no "emit dataChanged()" here
}

References m_id.

setMagnetization()

void MaterialItem::setMagnetization

(

const R3 &

magnetization

)

Definition at line 239 of file MaterialItem.cpp.

{
    if (m_magnetization != magnetization) {
        m_magnetization = magnetization;
        emit dataChanged();
    }
}

References dataChanged(), m_magnetization, and magnetization().

Here is the call graph for this function:

setMatItemName()

void MaterialItem::setMatItemName

(

const QString &

name

)

Definition at line 196 of file MaterialItem.cpp.

{
    if (m_name != name) {
        m_name = name;
        emit dataChanged();
    }
}

References dataChanged(), m_name, and GUI::RealSpace::Particles::name().

Referenced by MaterialEditorModel::setMaterialItemName().

Here is the call graph for this function:

setRefractiveIndex()

void MaterialItem::setRefractiveIndex	(	double	delta,
		double	beta
	)

Turns material into refractive index material.

Set refractive index as in 1 - delta + i * beta

Definition at line 65 of file MaterialItem.cpp.

{
    const Refractive r(delta, beta);
    if (hasRefractiveIndex() && std::get<Refractive>(m_data) == r)
        return;
 
    m_data = r;
    emit dataChanged();
}

References beta(), dataChanged(), delta(), hasRefractiveIndex(), and m_data.

Here is the call graph for this function:

setScatteringLengthDensity()

void MaterialItem::setScatteringLengthDensity

(

complex_t

sld

)

Turns material into SLD based material.

Definition at line 75 of file MaterialItem.cpp.

{
    if (!hasRefractiveIndex() && std::get<complex_t>(m_data) == sld)
        return;
 
    m_data = sld;
    emit dataChanged();
}

References dataChanged(), hasRefractiveIndex(), and m_data.

Here is the call graph for this function:

sldIm()

DoubleDescriptor MaterialItem::sldIm

(

)

Definition at line 135 of file MaterialItem.cpp.

{
    ASSERT(!hasRefractiveIndex());
    const auto setter = [=](double v) {
        if (m_imag != v) {
            std::get<complex_t>(m_data).imag(v);
            emit dataChanged();
        }
    };
 
    DoubleDescriptor d(
        "SLD, imaginary", "Imaginary part of SLD (SLD = real - i*imag), AA^{-2}", 3,
        RealLimits::limitless(), setter, [=] { return m_imag; }, Unit::unitless);
    d.path = [=] { return uidForDescriptor("im"); };
    return d;
}

References dataChanged(), hasRefractiveIndex(), m_data, m_imag, DoubleDescriptor::path, uidForDescriptor(), and unitless.

Referenced by MaterialEditorModel::data(), and serialize().

Here is the call graph for this function:

sldRe()

DoubleDescriptor MaterialItem::sldRe

(

)

Definition at line 118 of file MaterialItem.cpp.

{
    ASSERT(!hasRefractiveIndex());
    const auto setter = [=](double v) {
        if (m_real != v) {
            std::get<complex_t>(m_data).real(v);
            emit dataChanged();
        }
    };
 
    DoubleDescriptor d(
        "SLD, real", "Real part of SLD (SLD = real - i*imag), AA^{-2}", 3, RealLimits::limitless(),
        setter, [=] { return m_real; }, Unit::unitless);
    d.path = [=] { return uidForDescriptor("re"); };
    return d;
}

References dataChanged(), hasRefractiveIndex(), m_data, m_real, DoubleDescriptor::path, uidForDescriptor(), and unitless.

Referenced by MaterialEditorModel::data(), and serialize().

Here is the call graph for this function:

uidForDescriptor()

QString MaterialItem::uidForDescriptor ( const QString &  lastPart ) const

private

Returns a unique identifier for descriptors.

lastPart will be attached to identify the relevant descriptor.

Definition at line 333 of file MaterialItem.cpp.

{
    return "material/" + identifier() + "/" + lastPart;
}

References identifier().

Referenced by beta(), delta(), magnetizationVector(), sldIm(), and sldRe().

Here is the call graph for this function:

updateFrom()

void MaterialItem::updateFrom

(

const MaterialItem &

other

)

Updates content from the other material.

Does NOT change the identifier. emits dataChanged, if differences exist.

Definition at line 322 of file MaterialItem.cpp.

{
    if (operator!=(other)) {
        m_name = other.m_name;
        m_color = other.m_color;
        m_data = other.m_data;
        m_magnetization = other.m_magnetization;
        emit dataChanged();
    }
}

References dataChanged(), m_color, m_data, m_magnetization, m_name, and other.

writeContentTo()

void MaterialItem::writeContentTo

(

QXmlStreamWriter *

writer

)

const

Definition at line 257 of file MaterialItem.cpp.

{
    GUI::Session::XML::writeAttribute(writer, GUI::Session::XML::Version, int(1));
 
    GUI::Session::XML::writeAttribute(writer, Tags::Id, m_id);
    GUI::Session::XML::writeAttribute(writer, Tags::Color, m_color);
    GUI::Session::XML::writeAttribute(writer, Tags::Name, m_name);
    GUI::Session::XML::writeAttribute(writer, Tags::Magnetization, m_magnetization);
 
    if (hasRefractiveIndex()) {
        GUI::Session::XML::writeAttribute(writer, Tags::Delta, m_delta);
        GUI::Session::XML::writeAttribute(writer, Tags::Beta, m_beta);
    } else
        GUI::Session::XML::writeAttribute(writer, Tags::Sld, std::get<complex_t>(m_data));
}

References hasRefractiveIndex(), XML::Tags::Id(), m_beta, m_color, m_data, m_delta, m_id, m_magnetization, m_name, GUI::Session::XML::Version(), and GUI::Session::XML::writeAttribute().

Here is the call graph for this function:

Member Data Documentation

m_color

QColor MaterialItem::m_color

private

Definition at line 105 of file MaterialItem.h.

Referenced by MaterialItem(), color(), operator==(), readContentFrom(), serialize(), setColor(), updateFrom(), and writeContentTo().

m_data

std::variant<Refractive, complex_t> MaterialItem::m_data

private

Definition at line 119 of file MaterialItem.h.

Referenced by hasRefractiveIndex(), operator==(), readContentFrom(), serialize(), setRefractiveIndex(), setScatteringLengthDensity(), sldIm(), sldRe(), updateFrom(), and writeContentTo().

m_id

QString MaterialItem::m_id

private

Definition at line 104 of file MaterialItem.h.

Referenced by MaterialItem(), createNewIdentifier(), identifier(), operator==(), readContentFrom(), serialize(), setIdentifier(), and writeContentTo().

m_magnetization

R3 MaterialItem::m_magnetization

private

Definition at line 120 of file MaterialItem.h.

Referenced by createMaterial(), magnetization(), magnetizationVector(), operator==(), readContentFrom(), serialize(), setMagnetization(), updateFrom(), and writeContentTo().

m_name

QString MaterialItem::m_name

private

Definition at line 103 of file MaterialItem.h.

Referenced by matItemName(), operator==(), readContentFrom(), serialize(), setMatItemName(), updateFrom(), and writeContentTo().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/MaterialItem.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/MaterialItem.cpp