Lattice2DItem Class Reference

Description

Definition at line 26 of file Lattice2DItems.h.

Inheritance diagram for Lattice2DItem:

Collaboration diagram for Lattice2DItem:

Public Member Functions
virtual	~Lattice2DItem ()=default
virtual std::unique_ptr< Lattice2D >	createLattice () const =0
virtual DoubleDescriptors	geometryValues (bool withRotationAngle) const =0
DoubleDescriptor	latticeRotationAngle () const
virtual void	serialize (Streamer &s)=0
void	setLatticeRotationAngle (double angle)
double	unitCellArea () const

Protected Member Functions
	Lattice2DItem ()

Protected Attributes
DoubleProperty	m_latticeRotationAngle

Constructor & Destructor Documentation

Lattice2DItem()

Lattice2DItem::Lattice2DItem ( )

protected

Definition at line 21 of file Lattice2DItems.cpp.

{
    m_latticeRotationAngle.init(
        "Xi", "Rotation of lattice with respect to x-axis of reference frame (beam direction)", 0.0,
        Unit::degree, "xi");
}

References degree, DoubleProperty::init(), and m_latticeRotationAngle.

Here is the call graph for this function:

~Lattice2DItem()

virtual Lattice2DItem::~Lattice2DItem ( )

virtualdefault

Member Function Documentation

createLattice()

virtual std::unique_ptr<Lattice2D> Lattice2DItem::createLattice ( ) const

pure virtual

Implemented in HexagonalLattice2DItem, SquareLattice2DItem, and BasicLattice2DItem.

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

geometryValues()

virtual DoubleDescriptors Lattice2DItem::geometryValues ( bool  withRotationAngle ) const

pure virtual

Implemented in HexagonalLattice2DItem, SquareLattice2DItem, and BasicLattice2DItem.

latticeRotationAngle()

DoubleDescriptor Lattice2DItem::latticeRotationAngle

(

)

const

Definition at line 33 of file Lattice2DItems.cpp.

{
    return m_latticeRotationAngle;
}

References m_latticeRotationAngle.

Referenced by BasicLattice2DItem::createLattice(), SquareLattice2DItem::createLattice(), and HexagonalLattice2DItem::createLattice().

serialize()

virtual void Lattice2DItem::serialize ( Streamer &  s )

pure virtual

Implemented in HexagonalLattice2DItem, SquareLattice2DItem, and BasicLattice2DItem.

setLatticeRotationAngle()

void Lattice2DItem::setLatticeRotationAngle

(

double

angle

)

Definition at line 38 of file Lattice2DItems.cpp.

{
    m_latticeRotationAngle.set(angle);
}

References m_latticeRotationAngle, and DoubleProperty::set().

Here is the call graph for this function:

unitCellArea()

double Lattice2DItem::unitCellArea

(

)

const

Definition at line 28 of file Lattice2DItems.cpp.

{
    return createLattice()->unitCellArea();
}

References createLattice().

Referenced by ParticleLayoutItem::totalDensityValue().

Here is the call graph for this function:

Member Data Documentation

m_latticeRotationAngle

DoubleProperty Lattice2DItem::m_latticeRotationAngle

protected

Definition at line 41 of file Lattice2DItems.h.

Referenced by Lattice2DItem(), BasicLattice2DItem::geometryValues(), SquareLattice2DItem::geometryValues(), HexagonalLattice2DItem::geometryValues(), latticeRotationAngle(), BasicLattice2DItem::serialize(), SquareLattice2DItem::serialize(), HexagonalLattice2DItem::serialize(), and setLatticeRotationAngle().

---

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

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