InterferenceHardDiskItem Class Reference

Description

Definition at line 145 of file InterferenceItems.h.

Inheritance diagram for InterferenceHardDiskItem:

Collaboration diagram for InterferenceHardDiskItem:

Public Member Functions
	InterferenceHardDiskItem ()
std::unique_ptr< IInterference >	createInterference () const override
DoubleDescriptor	density () const
DoubleDescriptor	positionVariance () const
DoubleDescriptor	radius () const
void	serialize (Streamer &s) override

Protected Attributes
DoubleProperty	m_positionVariance

Private Attributes
DoubleProperty	m_density
DoubleProperty	m_radius

Constructor & Destructor Documentation

InterferenceHardDiskItem()

InterferenceHardDiskItem::InterferenceHardDiskItem

(

)

Definition at line 312 of file InterferenceItems.cpp.

{
    m_radius.init("Radius", "Hard disk radius", 5.0, Unit::nanometer, "radius");
    m_density.init("Total particle density", "Particle density in particles per area", 0.002,
                   Unit::nanometerMinus2, "density");
}

References DoubleProperty::init(), m_density, m_radius, nanometer, and nanometerMinus2.

Here is the call graph for this function:

Member Function Documentation

createInterference()

std::unique_ptr< IInterference > InterferenceHardDiskItem::createInterference ( ) const

overridevirtual

Implements InterferenceItem.

Definition at line 319 of file InterferenceItems.cpp.

{
    auto result = std::make_unique<InterferenceHardDisk>(m_radius, m_density);
    result->setPositionVariance(positionVariance());
    return std::unique_ptr<IInterference>(result.release());
}

References m_density, m_radius, and InterferenceItem::positionVariance().

Here is the call graph for this function:

density()

DoubleDescriptor InterferenceHardDiskItem::density

(

)

const

Definition at line 334 of file InterferenceItems.cpp.

{
    return m_density;
}

References m_density.

positionVariance()

DoubleDescriptor InterferenceItem::positionVariance ( ) const

inherited

Definition at line 31 of file InterferenceItems.cpp.

{
    return m_positionVariance;
}

References InterferenceItem::m_positionVariance.

Referenced by Interference1DLatticeItem::createInterference(), Interference2DLatticeItem::createInterference(), Interference2DParaCrystalItem::createInterference(), InterferenceFinite2DLatticeItem::createInterference(), createInterference(), and InterferenceRadialParaCrystalItem::createInterference().

radius()

DoubleDescriptor InterferenceHardDiskItem::radius

(

)

const

Definition at line 339 of file InterferenceItems.cpp.

{
    return m_radius;
}

References m_radius.

serialize()

void InterferenceHardDiskItem::serialize ( Streamer &  s )

overridevirtual

Implements InterferenceItem.

Definition at line 326 of file InterferenceItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_positionVariance);
    Serialize::rwProperty(s, m_radius);
    Serialize::rwProperty(s, m_density);
}

References Streamer::assertVersion(), m_density, InterferenceItem::m_positionVariance, m_radius, and Serialize::rwProperty().

Here is the call graph for this function:

Member Data Documentation

m_density

DoubleProperty InterferenceHardDiskItem::m_density

private

Definition at line 156 of file InterferenceItems.h.

Referenced by InterferenceHardDiskItem(), createInterference(), density(), and serialize().

m_positionVariance

DoubleProperty InterferenceItem::m_positionVariance

protectedinherited

Definition at line 39 of file InterferenceItems.h.

Referenced by InterferenceItem::InterferenceItem(), InterferenceItem::positionVariance(), Interference1DLatticeItem::serialize(), Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), serialize(), InterferenceRadialParaCrystalItem::serialize(), and InterferenceItem::serialize().

m_radius

DoubleProperty InterferenceHardDiskItem::m_radius

private

Definition at line 155 of file InterferenceItems.h.

Referenced by InterferenceHardDiskItem(), createInterference(), radius(), and serialize().

---

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

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