From 5a12fb894eee5cfde773e97b50b5fbad662b77df Mon Sep 17 00:00:00 2001
From: Matthias Puchner <github@mpuchner.de>
Date: Mon, 29 Nov 2021 09:49:38 +0100
Subject: [PATCH] better naming
---
GUI/Model/Job/JobModelFunctions.cpp | 2 +-
GUI/Model/Material/MaterialItem.cpp | 4 ++--
GUI/Model/Material/MaterialItem.h | 4 ++--
GUI/Model/Material/MaterialModel.cpp | 10 +++++-----
GUI/Model/Sample/ItemWithMaterial.cpp | 6 +++---
GUI/Model/Sample/ItemWithMaterial.h | 4 ++--
GUI/Model/Sample/ParticleItem.cpp | 2 +-
GUI/Model/To/ToDomain.cpp | 3 ++-
GUI/View/MaterialEditor/MaterialEditorDialog.cpp | 2 +-
GUI/View/MaterialEditor/MaterialEditorModel.cpp | 4 ++--
GUI/View/SampleDesigner/MaterialInplaceForm.cpp | 2 +-
Tests/Unit/GUI/TestMaterialModel.cpp | 12 ++++++------
12 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/GUI/Model/Job/JobModelFunctions.cpp b/GUI/Model/Job/JobModelFunctions.cpp
index d8530b623b7..728affd0dd1 100644
--- a/GUI/Model/Job/JobModelFunctions.cpp
+++ b/GUI/Model/Job/JobModelFunctions.cpp
@@ -134,7 +134,7 @@ void GUI::Model::JobFunctions::setupJobItemSampleData(JobItem* jobItem,
MaterialItemContainer* container = jobItem->createMaterialContainer();
for (auto* itemWithMaterial : sampleItem->itemsWithMaterial()) {
- auto* material = itemWithMaterial->material();
+ auto* material = itemWithMaterial->materialItem();
if (!container->findMaterialById(material->identifier())) {
auto* materialCopy = container->insertCopy(material);
materialCopy->setIdentifier(material->identifier()); // insertCopy() doesn't do this
diff --git a/GUI/Model/Material/MaterialItem.cpp b/GUI/Model/Material/MaterialItem.cpp
index a122144b50f..03257f19837 100644
--- a/GUI/Model/Material/MaterialItem.cpp
+++ b/GUI/Model/Material/MaterialItem.cpp
@@ -125,12 +125,12 @@ complex_t MaterialItem::scatteringLengthDensity() const
return complex_t(real, imag);
}
-QString MaterialItem::name() const
+QString MaterialItem::materialName() const
{
return itemName();
}
-void MaterialItem::setName(const QString& name)
+void MaterialItem::setMaterialName(const QString& name)
{
setItemName(name);
}
diff --git a/GUI/Model/Material/MaterialItem.h b/GUI/Model/Material/MaterialItem.h
index c030539f440..f6aa0b94e21 100644
--- a/GUI/Model/Material/MaterialItem.h
+++ b/GUI/Model/Material/MaterialItem.h
@@ -55,8 +55,8 @@ public:
/// \pre ! hasRefractiveIndex
complex_t scatteringLengthDensity() const;
- QString name() const;
- void setName(const QString& name);
+ QString materialName() const;
+ void setMaterialName(const QString& name);
QString identifier() const;
void setIdentifier(const QString& id);
diff --git a/GUI/Model/Material/MaterialModel.cpp b/GUI/Model/Material/MaterialModel.cpp
index 01b2e627866..b30da41d677 100644
--- a/GUI/Model/Material/MaterialModel.cpp
+++ b/GUI/Model/Material/MaterialModel.cpp
@@ -50,7 +50,7 @@ MaterialModel::~MaterialModel()
GUI::Model::MaterialModelStore::unsubscribe(this);
}
-void MaterialModel::clear()
+void MaterialModel::clear()
{
SessionModel::clear();
}
@@ -65,7 +65,7 @@ MaterialModel* MaterialModel::createCopy(SessionItem* parent)
MaterialItem* MaterialModel::addRefractiveMaterial(const QString& name, double delta, double beta)
{
auto* materialItem = insertItem<MaterialItem>();
- materialItem->setName(name);
+ materialItem->setMaterialName(name);
materialItem->setColor(suggestMaterialColor(name));
materialItem->setRefractiveIndex(delta, beta);
return materialItem;
@@ -74,7 +74,7 @@ MaterialItem* MaterialModel::addRefractiveMaterial(const QString& name, double d
MaterialItem* MaterialModel::addSLDMaterial(const QString& name, double sld, double abs_term)
{
auto* materialItem = insertItem<MaterialItem>();
- materialItem->setName(name);
+ materialItem->setMaterialName(name);
materialItem->setColor(suggestMaterialColor(name));
materialItem->setScatteringLengthDensity(complex_t(sld, abs_term));
return materialItem;
@@ -83,7 +83,7 @@ MaterialItem* MaterialModel::addSLDMaterial(const QString& name, double sld, dou
MaterialItem* MaterialModel::materialFromName(const QString& name)
{
for (auto* materialItem : topItems<MaterialItem>())
- if (materialItem->name() == name)
+ if (materialItem->materialName() == name)
return materialItem;
return nullptr;
@@ -105,7 +105,7 @@ MaterialItem* MaterialModel::cloneMaterial(MaterialItem* material)
auto* clonedMaterial = copyItem(material, nullptr);
clonedMaterial->setIdentifier(QUuid::createUuid().toString());
- clonedMaterial->setName(material->name() + " (copy)");
+ clonedMaterial->setMaterialName(material->materialName() + " (copy)");
return clonedMaterial;
}
diff --git a/GUI/Model/Sample/ItemWithMaterial.cpp b/GUI/Model/Sample/ItemWithMaterial.cpp
index 96663c79d1e..7a2601e9fc5 100644
--- a/GUI/Model/Sample/ItemWithMaterial.cpp
+++ b/GUI/Model/Sample/ItemWithMaterial.cpp
@@ -41,12 +41,12 @@ void ItemWithMaterial::setMaterialUndefined()
QColor ItemWithMaterial::materialColor() const
{
- return material()->color();
+ return materialItem()->color();
}
QString ItemWithMaterial::materialName() const
{
- return material()->name();
+ return materialItem()->materialName();
}
QString ItemWithMaterial::materialIdentifier() const
@@ -54,7 +54,7 @@ QString ItemWithMaterial::materialIdentifier() const
return getItemValue(P_MATERIAL).toString();
}
-MaterialItem* ItemWithMaterial::material() const
+MaterialItem* ItemWithMaterial::materialItem() const
{
const auto* const parentJob = GUI::Model::JobFunctions::findJobItem(this);
if (parentJob)
diff --git a/GUI/Model/Sample/ItemWithMaterial.h b/GUI/Model/Sample/ItemWithMaterial.h
index de7a890fc23..424b98a54c9 100644
--- a/GUI/Model/Sample/ItemWithMaterial.h
+++ b/GUI/Model/Sample/ItemWithMaterial.h
@@ -43,8 +43,8 @@ public:
QString materialName() const;
QString materialIdentifier() const;
- //! Returns the material this item links to.
- MaterialItem* material() const;
+ //! Returns the material item this item links to.
+ MaterialItem* materialItem() const;
protected:
ItemWithMaterial(const QString& model_type);
diff --git a/GUI/Model/Sample/ParticleItem.cpp b/GUI/Model/Sample/ParticleItem.cpp
index 1cc746420b2..4c138bbb2e4 100644
--- a/GUI/Model/Sample/ParticleItem.cpp
+++ b/GUI/Model/Sample/ParticleItem.cpp
@@ -49,7 +49,7 @@ ParticleItem::ParticleItem()
std::unique_ptr<Particle> ParticleItem::createParticle() const
{
auto& ffItem = groupItem<FormFactorItem>(P_FORM_FACTOR);
- auto domainMaterial = material()->createMaterial();
+ auto domainMaterial = materialItem()->createMaterial();
auto particle = std::make_unique<Particle>(*domainMaterial, *ffItem.createFormFactor());
particle->setAbundance(abundance());
diff --git a/GUI/Model/To/ToDomain.cpp b/GUI/Model/To/ToDomain.cpp
index ba0e31ee896..3d08dc1abaa 100644
--- a/GUI/Model/To/ToDomain.cpp
+++ b/GUI/Model/To/ToDomain.cpp
@@ -42,7 +42,8 @@ std::unique_ptr<MultiLayer> GUI::Transform::ToDomain::createMultiLayer(const Mul
std::unique_ptr<Layer> GUI::Transform::ToDomain::createLayer(const LayerItem& item)
{
- auto P_layer = std::make_unique<Layer>(*item.material()->createMaterial(), item.thickness());
+ auto P_layer =
+ std::make_unique<Layer>(*item.materialItem()->createMaterial(), item.thickness());
P_layer->setNumberOfSlices(item.numSlices());
return P_layer;
}
diff --git a/GUI/View/MaterialEditor/MaterialEditorDialog.cpp b/GUI/View/MaterialEditor/MaterialEditorDialog.cpp
index d38846b5e7d..66fb2465cfb 100644
--- a/GUI/View/MaterialEditor/MaterialEditorDialog.cpp
+++ b/GUI/View/MaterialEditor/MaterialEditorDialog.cpp
@@ -242,7 +242,7 @@ void MaterialEditorDialog::fill()
m_ui->refractiveGroupBox->setVisible(materialItem->hasRefractiveIndex());
m_ui->sldGroupBox->setVisible(!materialItem->hasRefractiveIndex());
- m_ui->nameEdit->setText(materialItem->name());
+ m_ui->nameEdit->setText(materialItem->materialName());
m_ui->colorInfo->setText(QString("[%1, %2, %3] (%4)")
.arg(materialItem->color().red())
.arg(materialItem->color().green())
diff --git a/GUI/View/MaterialEditor/MaterialEditorModel.cpp b/GUI/View/MaterialEditor/MaterialEditorModel.cpp
index 8b14b2272c5..607cab48710 100644
--- a/GUI/View/MaterialEditor/MaterialEditorModel.cpp
+++ b/GUI/View/MaterialEditor/MaterialEditorModel.cpp
@@ -62,7 +62,7 @@ QVariant MaterialEditorModel::data(const QModelIndex& index, int role /*= Qt::Di
if (role == Qt::DisplayRole) {
switch (index.column()) {
case NAME:
- return material->name();
+ return material->materialName();
case TYPE:
return material->hasRefractiveIndex() ? "Refractive based" : "SLD based";
@@ -99,7 +99,7 @@ QVariant MaterialEditorModel::data(const QModelIndex& index, int role /*= Qt::Di
void MaterialEditorModel::setMaterialItemName(const QModelIndex& index, const QString& name)
{
- materialFromIndex(index)->setName(name);
+ materialFromIndex(index)->setMaterialName(name);
emit dataChanged(index, index);
}
diff --git a/GUI/View/SampleDesigner/MaterialInplaceForm.cpp b/GUI/View/SampleDesigner/MaterialInplaceForm.cpp
index 52e254525ba..a3cb3aa494b 100644
--- a/GUI/View/SampleDesigner/MaterialInplaceForm.cpp
+++ b/GUI/View/SampleDesigner/MaterialInplaceForm.cpp
@@ -161,7 +161,7 @@ void MaterialInplaceForm::createWidgets()
MaterialItem* MaterialInplaceForm::material()
{
- return m_item->material();
+ return m_item->materialItem();
}
void MaterialInplaceForm::onMaterialChanged(MaterialItem* materialItem)
diff --git a/Tests/Unit/GUI/TestMaterialModel.cpp b/Tests/Unit/GUI/TestMaterialModel.cpp
index 5b67e7ae04c..625f7b4af97 100644
--- a/Tests/Unit/GUI/TestMaterialModel.cpp
+++ b/Tests/Unit/GUI/TestMaterialModel.cpp
@@ -21,7 +21,7 @@ TEST_F(TestMaterialModel, addRefractiveMaterial)
EXPECT_EQ(model->materialItems().size(), 1);
EXPECT_EQ(model->itemForIndex(material->index()), material);
- EXPECT_EQ(material->name(), name);
+ EXPECT_EQ(material->materialName(), name);
EXPECT_TRUE(material->hasRefractiveIndex());
EXPECT_EQ(material->refractiveIndexDelta(), delta);
EXPECT_EQ(material->refractiveIndexBeta(), beta);
@@ -40,7 +40,7 @@ TEST_F(TestMaterialModel, addSLDMaterial)
EXPECT_EQ(model->materialItems().size(), 1);
EXPECT_EQ(model->itemForIndex(material->index()), material);
- EXPECT_EQ(material->name(), name);
+ EXPECT_EQ(material->materialName(), name);
EXPECT_FALSE(material->hasRefractiveIndex());
EXPECT_EQ(material->scatteringLengthDensity(), complex_t(sld_real, sld_imag));
}
@@ -66,7 +66,7 @@ TEST_F(TestMaterialModel, cloneMaterialRefractive)
EXPECT_NE(clonedMaterial->identifier(), material->identifier());
// checking name of cloned material
- EXPECT_EQ(material->name() + " (copy)", clonedMaterial->name());
+ EXPECT_EQ(material->materialName() + " (copy)", clonedMaterial->materialName());
EXPECT_EQ(material->hasRefractiveIndex(), clonedMaterial->hasRefractiveIndex());
EXPECT_EQ(material->refractiveIndexDelta(), delta);
EXPECT_EQ(material->refractiveIndexBeta(), beta);
@@ -93,7 +93,7 @@ TEST_F(TestMaterialModel, cloneMaterialSLD)
EXPECT_NE(clonedMaterial->identifier(), material->identifier());
// checking name of cloned material
- EXPECT_EQ(material->name() + " (copy)", clonedMaterial->name());
+ EXPECT_EQ(material->materialName() + " (copy)", clonedMaterial->materialName());
EXPECT_EQ(material->hasRefractiveIndex(), clonedMaterial->hasRefractiveIndex());
EXPECT_EQ(material->scatteringLengthDensity(), complex_t(real, imag));
}
@@ -117,8 +117,8 @@ TEST_F(TestMaterialModel, materialFromName)
MaterialModel model;
MaterialItem* material1 = model.addRefractiveMaterial("aaa", 1.0, 2.0);
MaterialItem* material2 = model.addRefractiveMaterial("bbb", 3.0, 4.0);
- EXPECT_EQ(material1, model.materialFromName(material1->name()));
- EXPECT_EQ(material2, model.materialFromName(material2->name()));
+ EXPECT_EQ(material1, model.materialFromName(material1->materialName()));
+ EXPECT_EQ(material2, model.materialFromName(material2->materialName()));
EXPECT_EQ(nullptr, model.materialFromName("non-existing-name"));
}
--
GitLab