Interference2DLatticeItem Class Reference

Description

Definition at line 82 of file InterferenceItems.h.

Inheritance diagram for Interference2DLatticeItem:

Collaboration diagram for Interference2DLatticeItem:

Public Member Functions
	Interference2DLatticeItem ()
std::unique_ptr< IInterference >	createInterference () const override
SelectionDescriptor< Profile2DItem * >	decayFunction () const
SelectionDescriptor< Lattice2DItem * >	latticeType () const
DoubleDescriptor	positionVariance () const
void	serialize (Streamer &s) override
void	setDecayFunctionType (Profile2DItem *p)
void	setLatticeType (Lattice2DItem *p)
void	setXiIntegration (bool xiIntegration)
bool	xiIntegration () const

Protected Attributes
SelectionProperty< Profile2DItem * >	m_decayFunction
SelectionProperty< Lattice2DItem * >	m_latticeType
DoubleProperty	m_positionVariance
bool	m_xiIntegration

Constructor & Destructor Documentation

Interference2DLatticeItem()

Interference2DLatticeItem::Interference2DLatticeItem

(

)

Definition at line 123 of file InterferenceItems.cpp.

    : Interference2DAbstractLatticeItem(false)
{
    m_decayFunction.init<Profile2DItemCatalog>(
        "Decay Function", "Two-dimensional decay function (finite size effects)", "decay");
}

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

Here is the call graph for this function:

Member Function Documentation

createInterference()

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

overridevirtual

Implements InterferenceItem.

Definition at line 130 of file InterferenceItems.cpp.

{
    Lattice2DItem* latticeItem = latticeType().currentItem();
    std::unique_ptr<Interference2DLattice> result(
        new Interference2DLattice(*latticeItem->createLattice()));
 
    result->setDecayFunction(*m_decayFunction->createProfile());
    result->setIntegrationOverXi(xiIntegration());
    result->setPositionVariance(positionVariance());
 
    return std::unique_ptr<IInterference>(result.release());
}

References Lattice2DItem::createLattice(), Profile2DItem::createProfile(), Interference2DAbstractLatticeItem::latticeType(), m_decayFunction, InterferenceItem::positionVariance(), and Interference2DAbstractLatticeItem::xiIntegration().

Here is the call graph for this function:

decayFunction()

SelectionDescriptor< Profile2DItem * > Interference2DLatticeItem::decayFunction

(

)

const

Definition at line 157 of file InterferenceItems.cpp.

{
    return m_decayFunction;
}

References m_decayFunction.

latticeType()

SelectionDescriptor< Lattice2DItem * > Interference2DAbstractLatticeItem::latticeType ( ) const

inherited

Definition at line 94 of file InterferenceItems.cpp.

{
    return m_latticeType;
}

References Interference2DAbstractLatticeItem::m_latticeType.

Referenced by LatticeTypeSelectionForm::LatticeTypeSelectionForm(), ParameterTreeBuilder::addLattice(), LatticeTypeSelectionForm::createContent(), createInterference(), Interference2DParaCrystalItem::createInterference(), and InterferenceFinite2DLatticeItem::createInterference().

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(), createInterference(), Interference2DParaCrystalItem::createInterference(), InterferenceFinite2DLatticeItem::createInterference(), InterferenceHardDiskItem::createInterference(), and InterferenceRadialParaCrystalItem::createInterference().

serialize()

void Interference2DLatticeItem::serialize ( Streamer &  s )

overridevirtual

Implements InterferenceItem.

Definition at line 143 of file InterferenceItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_positionVariance);
    Serialize::rwValue(s, "integrate", m_xiIntegration);
    Serialize::rwSelected<Lattice2DItemCatalog>(s, m_latticeType);
    Serialize::rwSelected<Profile2DItemCatalog>(s, m_decayFunction);
}

References Streamer::assertVersion(), m_decayFunction, Interference2DAbstractLatticeItem::m_latticeType, InterferenceItem::m_positionVariance, Interference2DAbstractLatticeItem::m_xiIntegration, Serialize::rwProperty(), and Serialize::rwValue().

Here is the call graph for this function:

setDecayFunctionType()

void Interference2DLatticeItem::setDecayFunctionType

(

Profile2DItem *

p

)

Definition at line 152 of file InterferenceItems.cpp.

{
    m_decayFunction.set(p);
}

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

Here is the call graph for this function:

setLatticeType()

void Interference2DAbstractLatticeItem::setLatticeType ( Lattice2DItem *  p )

inherited

Definition at line 99 of file InterferenceItems.cpp.

{
    m_latticeType.set(p);
}

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

Here is the call graph for this function:

setXiIntegration()

void Interference2DAbstractLatticeItem::setXiIntegration ( bool  xiIntegration )

inherited

Definition at line 109 of file InterferenceItems.cpp.

{
    m_xiIntegration = xiIntegration;
}

References Interference2DAbstractLatticeItem::m_xiIntegration, and Interference2DAbstractLatticeItem::xiIntegration().

Referenced by SampleEditorController::setIntegrateOverXi().

Here is the call graph for this function:

xiIntegration()

bool Interference2DAbstractLatticeItem::xiIntegration ( ) const

inherited

Definition at line 104 of file InterferenceItems.cpp.

{
    return m_xiIntegration;
}

References Interference2DAbstractLatticeItem::m_xiIntegration.

Referenced by ParameterTreeBuilder::addLattice(), LatticeTypeSelectionForm::createContent(), createInterference(), Interference2DParaCrystalItem::createInterference(), InterferenceFinite2DLatticeItem::createInterference(), LatticeTypeSelectionForm::onIntegrateOverXiChanged(), Interference2DAbstractLatticeItem::setXiIntegration(), and LatticeTypeSelectionForm::updateXiVisibility().

Member Data Documentation

m_decayFunction

SelectionProperty<Profile2DItem*> Interference2DLatticeItem::m_decayFunction

protected

Definition at line 92 of file InterferenceItems.h.

Referenced by Interference2DLatticeItem(), createInterference(), decayFunction(), serialize(), and setDecayFunctionType().

m_latticeType

SelectionProperty<Lattice2DItem*> Interference2DAbstractLatticeItem::m_latticeType

protectedinherited

Definition at line 77 of file InterferenceItems.h.

Referenced by Interference2DAbstractLatticeItem::Interference2DAbstractLatticeItem(), Interference2DAbstractLatticeItem::latticeType(), serialize(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), and Interference2DAbstractLatticeItem::setLatticeType().

m_positionVariance

DoubleProperty InterferenceItem::m_positionVariance

protectedinherited

Definition at line 39 of file InterferenceItems.h.

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

m_xiIntegration

bool Interference2DAbstractLatticeItem::m_xiIntegration

protectedinherited

Definition at line 76 of file InterferenceItems.h.

Referenced by serialize(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), Interference2DAbstractLatticeItem::setXiIntegration(), and Interference2DAbstractLatticeItem::xiIntegration().

---

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