Interference1DLatticeItem Class Reference

Description

Definition at line 44 of file InterferenceItems.h.

Inheritance diagram for Interference1DLatticeItem:

Collaboration diagram for Interference1DLatticeItem:

Public Member Functions
	Interference1DLatticeItem ()
std::unique_ptr< IInterference >	createInterference () const override
SelectionDescriptor< Profile1DItem * >	decayFunction () const
DoubleDescriptor	length () const
DoubleDescriptor	positionVariance () const
DoubleDescriptor	rotationAngle () const
void	serialize (Streamer &s) override
void	setDecayFunction (Profile1DItem *p)

Protected Attributes
DoubleProperty	m_positionVariance

Private Attributes
SelectionProperty< Profile1DItem * >	m_decayFunction
DoubleProperty	m_length
DoubleProperty	m_rotationAngle

Constructor & Destructor Documentation

Interference1DLatticeItem()

Interference1DLatticeItem::Interference1DLatticeItem

(

)

Definition at line 44 of file InterferenceItems.cpp.

{
    m_length.init("Length", "Lattice length", 20.0, Unit::nanometer, "Length");
    m_rotationAngle.init(
        "Xi", "Rotation of lattice with respect to x-axis of reference frame (beam direction)", 0.0,
        Unit::degree, "xi");
    m_decayFunction.init<Profile1DItemCatalog>(
        "Decay Function", "One-dimensional decay function (finite size effects)", "decay");
}

References degree, SelectionProperty< T >::init(), DoubleProperty::init(), m_decayFunction, m_length, m_rotationAngle, and nanometer.

Here is the call graph for this function:

Member Function Documentation

createInterference()

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

overridevirtual

Implements InterferenceItem.

Definition at line 54 of file InterferenceItems.cpp.

{
    auto result =
        std::make_unique<Interference1DLattice>(m_length, Units::deg2rad(m_rotationAngle));
    result->setDecayFunction(*m_decayFunction->createProfile());
    result->setPositionVariance(positionVariance());
    return std::unique_ptr<IInterference>(result.release());
}

References Profile1DItem::createProfile(), m_decayFunction, m_length, m_rotationAngle, and InterferenceItem::positionVariance().

Here is the call graph for this function:

decayFunction()

SelectionDescriptor< Profile1DItem * > Interference1DLatticeItem::decayFunction

(

)

const

Definition at line 78 of file InterferenceItems.cpp.

{
    return m_decayFunction;
}

References m_decayFunction.

length()

DoubleDescriptor Interference1DLatticeItem::length

(

)

const

Definition at line 63 of file InterferenceItems.cpp.

{
    return m_length;
}

References m_length.

positionVariance()

DoubleDescriptor InterferenceItem::positionVariance ( ) const

inherited

Definition at line 31 of file InterferenceItems.cpp.

{
    return m_positionVariance;
}

References InterferenceItem::m_positionVariance.

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

rotationAngle()

DoubleDescriptor Interference1DLatticeItem::rotationAngle

(

)

const

Definition at line 68 of file InterferenceItems.cpp.

{
    return m_rotationAngle;
}

References m_rotationAngle.

serialize()

void Interference1DLatticeItem::serialize ( Streamer &  s )

overridevirtual

Implements InterferenceItem.

Definition at line 83 of file InterferenceItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_positionVariance);
    Serialize::rwProperty(s, m_length);
    Serialize::rwProperty(s, m_rotationAngle);
    Serialize::rwSelected<Profile1DItemCatalog>(s, m_decayFunction);
}

References Streamer::assertVersion(), m_decayFunction, m_length, InterferenceItem::m_positionVariance, m_rotationAngle, and Serialize::rwProperty().

Here is the call graph for this function:

setDecayFunction()

void Interference1DLatticeItem::setDecayFunction

(

Profile1DItem *

p

)

Definition at line 73 of file InterferenceItems.cpp.

{
    m_decayFunction.set(p);
}

References m_decayFunction, and SelectionProperty< T >::set().

Here is the call graph for this function:

Member Data Documentation

m_decayFunction

SelectionProperty<Profile1DItem*> Interference1DLatticeItem::m_decayFunction

private

Definition at line 60 of file InterferenceItems.h.

Referenced by Interference1DLatticeItem(), createInterference(), decayFunction(), serialize(), and setDecayFunction().

m_length

DoubleProperty Interference1DLatticeItem::m_length

private

Definition at line 58 of file InterferenceItems.h.

Referenced by Interference1DLatticeItem(), createInterference(), length(), and serialize().

m_positionVariance

DoubleProperty InterferenceItem::m_positionVariance

protectedinherited

Definition at line 39 of file InterferenceItems.h.

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

m_rotationAngle

DoubleProperty Interference1DLatticeItem::m_rotationAngle

private

Definition at line 59 of file InterferenceItems.h.

Referenced by Interference1DLatticeItem(), createInterference(), rotationAngle(), 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