InterferenceFinite2DLatticeItem Class Reference

Description

Definition at line 127 of file InterferenceItems.h.

Inheritance diagram for InterferenceFinite2DLatticeItem:

Collaboration diagram for InterferenceFinite2DLatticeItem:

Public Member Functions
	InterferenceFinite2DLatticeItem ()
std::unique_ptr< IInterference >	createInterference () const override
UIntDescriptor	domainSize1 () const
UIntDescriptor	domainSize2 () const
SelectionDescriptor< Lattice2DItem * >	latticeType () const
DoubleDescriptor	positionVariance () const
void	serialize (Streamer &s) override
void	setDomainSize1 (unsigned int domain_size1)
void	setDomainSize2 (unsigned int domain_size2)
void	setLatticeType (Lattice2DItem *p)
void	setXiIntegration (bool xiIntegration)
bool	xiIntegration () const

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

Private Attributes
UIntProperty	m_domainSize1
UIntProperty	m_domainSize2

Constructor & Destructor Documentation

InterferenceFinite2DLatticeItem()

InterferenceFinite2DLatticeItem::InterferenceFinite2DLatticeItem

(

)

Definition at line 259 of file InterferenceItems.cpp.

    : Interference2DAbstractLatticeItem(false)
{
    m_domainSize1.init("Domain size 1", "Domain size 1 in number of unit cells", 100,
                       Unit::unitless, "size1");
    m_domainSize2.init("Domain size 2", "Domain size 2 in number of unit cells", 100,
                       Unit::unitless, "size2");
}

References UIntProperty::init(), m_domainSize1, m_domainSize2, and unitless.

Here is the call graph for this function:

Member Function Documentation

createInterference()

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

overridevirtual

Implements InterferenceItem.

Definition at line 268 of file InterferenceItems.cpp.

{
    Lattice2DItem* latticeItem = latticeType().currentItem();
    auto result = std::make_unique<InterferenceFinite2DLattice>(*latticeItem->createLattice(),
                                                                m_domainSize1, m_domainSize2);
 
    result->setIntegrationOverXi(xiIntegration());
    result->setPositionVariance(positionVariance());
 
    return result;
}

References Lattice2DItem::createLattice(), Interference2DAbstractLatticeItem::latticeType(), m_domainSize1, m_domainSize2, InterferenceItem::positionVariance(), and Interference2DAbstractLatticeItem::xiIntegration().

Here is the call graph for this function:

domainSize1()

UIntDescriptor InterferenceFinite2DLatticeItem::domainSize1

(

)

const

Definition at line 290 of file InterferenceItems.cpp.

{
    return m_domainSize1;
}

References m_domainSize1.

domainSize2()

UIntDescriptor InterferenceFinite2DLatticeItem::domainSize2

(

)

const

Definition at line 300 of file InterferenceItems.cpp.

{
    return m_domainSize2;
}

References m_domainSize2.

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

serialize()

void InterferenceFinite2DLatticeItem::serialize ( Streamer &  s )

overridevirtual

Implements InterferenceItem.

Definition at line 280 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::rwProperty(s, m_domainSize1);
    Serialize::rwProperty(s, m_domainSize2);
}

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

Here is the call graph for this function:

setDomainSize1()

void InterferenceFinite2DLatticeItem::setDomainSize1

(

unsigned int

domain_size1

)

Definition at line 295 of file InterferenceItems.cpp.

{
    m_domainSize1.set(size);
}

References m_domainSize1, and UIntProperty::set().

Here is the call graph for this function:

setDomainSize2()

void InterferenceFinite2DLatticeItem::setDomainSize2

(

unsigned int

domain_size2

)

Definition at line 305 of file InterferenceItems.cpp.

{
    m_domainSize2.set(size);
}

References m_domainSize2, and UIntProperty::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(), Interference2DLatticeItem::createInterference(), Interference2DParaCrystalItem::createInterference(), createInterference(), LatticeTypeSelectionForm::onIntegrateOverXiChanged(), Interference2DAbstractLatticeItem::setXiIntegration(), and LatticeTypeSelectionForm::updateXiVisibility().

Member Data Documentation

m_domainSize1

UIntProperty InterferenceFinite2DLatticeItem::m_domainSize1

private

Definition at line 139 of file InterferenceItems.h.

Referenced by InterferenceFinite2DLatticeItem(), createInterference(), domainSize1(), serialize(), and setDomainSize1().

m_domainSize2

UIntProperty InterferenceFinite2DLatticeItem::m_domainSize2

private

Definition at line 140 of file InterferenceItems.h.

Referenced by InterferenceFinite2DLatticeItem(), createInterference(), domainSize2(), serialize(), and setDomainSize2().

m_latticeType

SelectionProperty<Lattice2DItem*> Interference2DAbstractLatticeItem::m_latticeType

protectedinherited

Definition at line 77 of file InterferenceItems.h.

Referenced by Interference2DAbstractLatticeItem::Interference2DAbstractLatticeItem(), Interference2DAbstractLatticeItem::latticeType(), Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), 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(), Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), 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 Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), 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