MultiLayerItem Class Reference

Description

Definition at line 31 of file MultiLayerItem.h.

Collaboration diagram for MultiLayerItem:

Public Member Functions
	MultiLayerItem ()
LayerItem *	addLayer (int index=-1)
	Creates and inserts a layer at given index. More...
void	addStandardMaterials ()
DoubleDescriptor	crossCorrLength () const
QString	description () const
R3	externalField () const
VectorDescriptor	externalFieldVector () const
void	initFrom (const MultiLayerItem *other)
QVector< ItemWithMaterial * >	itemsWithMaterial () const
QVector< LayerItem * >	layers () const
MaterialItems &	materialItems ()
const MaterialItems &	materialItems () const
void	moveLayer (LayerItem *item, LayerItem *beforeThisLayer)
void	readContentFrom (QXmlStreamReader *reader)
void	removeLayer (LayerItem *item)
QString	sampleName () const
void	serialize (Streamer &s)
void	setDescription (const QString &description)
void	setExternalField (const R3 &externalField)
void	setSampleName (const QString &name)
void	writeContentTo (QXmlStreamWriter *writer) const

Private Attributes
DoubleProperty	m_crossCorrelationLength
QString	m_description
VectorProperty	m_externalField
QVector< LayerItem * >	m_layers
MaterialItems	m_materials
QString	m_name

Constructor & Destructor Documentation

MultiLayerItem()

MultiLayerItem::MultiLayerItem

(

)

Definition at line 21 of file MultiLayerItem.cpp.

{
    m_name = "Sample";
    m_crossCorrelationLength.init("Cross-correlation length",
                                  "Cross correlation length of roughnesses between interfaces", 0.0,
                                  Unit::nanometer, 5, RealLimits::nonnegative(), "cross");
    m_externalField.init("External field", "External field (A/m)", "A/m", "extField");
}

References VectorProperty::init(), DoubleProperty::init(), m_crossCorrelationLength, m_externalField, m_name, and nanometer.

Here is the call graph for this function:

Member Function Documentation

addLayer()

LayerItem * MultiLayerItem::addLayer

(

int

index = -1

)

Creates and inserts a layer at given index.

No properties etc. have been initialized, this has to be done by the caller If index = -1, create a layer at the end of the list.

Definition at line 96 of file MultiLayerItem.cpp.

{
    if (index < 0)
        index = m_layers.size();
 
    auto* layer = new LayerItem(&m_materials);
    m_layers.insert(index, layer);
    layer->setIsTopLayer(m_layers.first() == layer);
    layer->setIsBottomLayer(m_layers.last() == layer);
    return layer;
}

References m_layers, and m_materials.

Referenced by SampleEditorController::addLayerFromUndo(), and CommandRemoveLayer::undo().

addStandardMaterials()

void MultiLayerItem::addStandardMaterials

(

)

Definition at line 43 of file MultiLayerItem.cpp.

{
    m_materials.addRefractiveMaterial("Default", 1e-3, 1e-5);
    m_materials.addRefractiveMaterial("Vacuum", 0.0, 0.0);
    m_materials.addRefractiveMaterial("Particle", 6e-4, 2e-8);
    m_materials.addRefractiveMaterial("Substrate", 6e-6, 2e-8);
}

References MaterialItems::addRefractiveMaterial(), and m_materials.

Here is the call graph for this function:

crossCorrLength()

DoubleDescriptor MultiLayerItem::crossCorrLength

(

)

const

Definition at line 71 of file MultiLayerItem.cpp.

{
    return m_crossCorrelationLength;
}

References m_crossCorrelationLength.

Referenced by MultiLayerForm::MultiLayerForm(), and ParameterTreeBuilder::addSample().

description()

QString MultiLayerItem::description

(

)

const

Definition at line 61 of file MultiLayerItem.cpp.

{
    return m_description;
}

References m_description.

Referenced by MultiLayerForm::MultiLayerForm(), and setDescription().

externalField()

R3 MultiLayerItem::externalField

(

)

const

Definition at line 76 of file MultiLayerItem.cpp.

{
    return m_externalField;
}

References m_externalField.

Referenced by setExternalField().

externalFieldVector()

VectorDescriptor MultiLayerItem::externalFieldVector

(

)

const

Definition at line 86 of file MultiLayerItem.cpp.

{
    return m_externalField;
}

References m_externalField.

Referenced by MultiLayerForm::MultiLayerForm(), and ParameterTreeBuilder::addSample().

initFrom()

void MultiLayerItem::initFrom

(

const MultiLayerItem *

other

)

Definition at line 30 of file MultiLayerItem.cpp.

{
    GUI::Util::copyContents(other, this);
}

References GUI::Util::copyContents(), and other.

Referenced by JobItem::copySampleIntoJob().

Here is the call graph for this function:

itemsWithMaterial()

QVector< ItemWithMaterial * > MultiLayerItem::itemsWithMaterial

(

)

const

Definition at line 35 of file MultiLayerItem.cpp.

{
    QVector<ItemWithMaterial*> result;
    for (auto* layer : m_layers)
        result.append(layer->itemsWithMaterial());
    return result;
}

References m_layers.

Referenced by MaterialEditorDialog::identifiersOfUsedMaterials().

layers()

QVector< LayerItem * > MultiLayerItem::layers

(

)

const

Definition at line 91 of file MultiLayerItem.cpp.

{
    return m_layers;
}

References m_layers.

Referenced by CommandRemoveLayer::CommandRemoveLayer(), MultiLayerForm::MultiLayerForm(), SampleEditorController::addLayer(), SampleEditorController::addLayerFromUndo(), ParameterTreeBuilder::addSample(), LayerOrientedSampleEditor::createLayerColors(), LayerForm::enableStructureEditing(), SampleValidator::isValidMultiLayer(), GUI::Transform::ToCore::itemToSample(), MultiLayerForm::onLayerAdded(), MultiLayerForm::onLayerMoved(), RealSpaceBuilder::populateMultiLayer(), SampleEditorController::removeLayerFromUndo(), LayerForm::updateLayerPositionDependentElements(), and LayerForm::updateTitle().

materialItems() [1/2]

MaterialItems & MultiLayerItem::materialItems

(

)

Definition at line 168 of file MultiLayerItem.cpp.

{
    return m_materials;
}

References m_materials.

Referenced by MaterialEditorDialog::MaterialEditorDialog(), MaterialEditorDialog::accept(), ParameterTreeBuilder::addMaterials(), SampleEditorController::materialItems(), MaterialInplaceForm::selectMaterial(), and RealSpaceCanvas::updateScene().

materialItems() [2/2]

const MaterialItems & MultiLayerItem::materialItems

(

)

const

Definition at line 163 of file MultiLayerItem.cpp.

{
    return m_materials;
}

References m_materials.

moveLayer()

void MultiLayerItem::moveLayer	(	LayerItem *	item,
		LayerItem *	beforeThisLayer
	)

Definition at line 119 of file MultiLayerItem.cpp.

{
    m_layers.removeAll(layer);
    int index = m_layers.size(); // move to end
    if (beforeThisLayer != nullptr)
        index = m_layers.indexOf(beforeThisLayer);
    m_layers.insert(index, layer);
    for (auto* l : m_layers) {
        l->setIsTopLayer(m_layers.first() == l);
        l->setIsBottomLayer(m_layers.last() == l);
    }
}

References m_layers.

Referenced by SampleEditorController::onStoppedToMoveLayer().

readContentFrom()

void MultiLayerItem::readContentFrom

(

QXmlStreamReader *

reader

)

Definition at line 138 of file MultiLayerItem.cpp.

{
    Streamer s(reader);
    serialize(s);
}

References serialize().

Referenced by JobItem::readNonSessionItems().

Here is the call graph for this function:

removeLayer()

void MultiLayerItem::removeLayer

(

LayerItem *

item

)

Definition at line 108 of file MultiLayerItem.cpp.

{
    m_layers.removeAll(layer);
    delete layer;
 
    if (!m_layers.isEmpty()) {
        m_layers.first()->setIsTopLayer(true);
        m_layers.last()->setIsBottomLayer(true);
    }
}

References m_layers.

Referenced by SampleEditorController::removeLayerFromUndo().

sampleName()

QString MultiLayerItem::sampleName

(

)

const

Definition at line 51 of file MultiLayerItem.cpp.

{
    return m_name;
}

References m_name.

Referenced by MultiLayerForm::MultiLayerForm(), and JobItem::sampleName().

serialize()

void MultiLayerItem::serialize

(

Streamer &

s

)

Definition at line 144 of file MultiLayerItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwValue(s, "Name", m_name);
    Serialize::rwValue(s, "Description", m_description);
    Serialize::rwProperty(s, m_crossCorrelationLength);
    Serialize::rwProperty(s, m_externalField);
    Serialize::rwClass(s, "Materials", m_materials);
    Serialize::rwVector(s, "Layers", m_layers, &m_materials);
 
    if (s.xmlReader()) {
        // set non-stored infos
        for (auto* l : m_layers) {
            l->setIsTopLayer(m_layers.first() == l);
            l->setIsBottomLayer(m_layers.last() == l);
        }
    }
}

References Streamer::assertVersion(), m_crossCorrelationLength, m_description, m_externalField, m_layers, m_materials, m_name, Serialize::rwClass(), Serialize::rwProperty(), Serialize::rwValue(), Serialize::rwVector(), and Streamer::xmlReader().

Referenced by readContentFrom(), and writeContentTo().

Here is the call graph for this function:

setDescription()

void MultiLayerItem::setDescription

(

const QString &

description

)

Definition at line 66 of file MultiLayerItem.cpp.

{
    m_description = description;
}

References description(), and m_description.

Referenced by SampleListModel::setData(), and SampleEditorController::setSampleDescription().

Here is the call graph for this function:

setExternalField()

void MultiLayerItem::setExternalField

(

const R3 &

externalField

)

Definition at line 81 of file MultiLayerItem.cpp.

{
    m_externalField.set(externalField);
}

References externalField(), m_externalField, and VectorProperty::set().

Here is the call graph for this function:

setSampleName()

void MultiLayerItem::setSampleName

(

const QString &

name

)

Definition at line 56 of file MultiLayerItem.cpp.

{
    m_name = name;
}

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

Referenced by SampleListModel::createSample(), SampleListModel::createSampleFromExamples(), SampleListModel::setData(), and SampleEditorController::setSampleName().

Here is the call graph for this function:

writeContentTo()

void MultiLayerItem::writeContentTo

(

QXmlStreamWriter *

writer

)

const

Definition at line 132 of file MultiLayerItem.cpp.

{
    Streamer s(writer);
    const_cast<MultiLayerItem*>(this)->serialize(s);
}

References serialize().

Referenced by JobItem::writeNonSessionItems().

Here is the call graph for this function:

Member Data Documentation

m_crossCorrelationLength

DoubleProperty MultiLayerItem::m_crossCorrelationLength

private

Definition at line 74 of file MultiLayerItem.h.

Referenced by MultiLayerItem(), crossCorrLength(), and serialize().

m_description

QString MultiLayerItem::m_description

private

Definition at line 73 of file MultiLayerItem.h.

Referenced by description(), serialize(), and setDescription().

m_externalField

VectorProperty MultiLayerItem::m_externalField

private

Definition at line 75 of file MultiLayerItem.h.

Referenced by MultiLayerItem(), externalField(), externalFieldVector(), serialize(), and setExternalField().

m_layers

QVector<LayerItem*> MultiLayerItem::m_layers

private

Definition at line 76 of file MultiLayerItem.h.

Referenced by addLayer(), itemsWithMaterial(), layers(), moveLayer(), removeLayer(), and serialize().

m_materials

MaterialItems MultiLayerItem::m_materials

private

Definition at line 77 of file MultiLayerItem.h.

Referenced by addLayer(), addStandardMaterials(), materialItems(), and serialize().

m_name

QString MultiLayerItem::m_name

private

Definition at line 72 of file MultiLayerItem.h.

Referenced by MultiLayerItem(), sampleName(), serialize(), and setSampleName().

---

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

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