SquareLattice2DItem Class Reference

Description

Definition at line 75 of file Lattice2DItems.h.

Inheritance diagram for SquareLattice2DItem:

Collaboration diagram for SquareLattice2DItem:

Public Member Functions
	SquareLattice2DItem ()
std::unique_ptr< Lattice2D >	createLattice () const override
DoubleDescriptors	geometryValues (bool withRotationAngle) const override
DoubleDescriptor	latticeLength () const
DoubleDescriptor	latticeRotationAngle () const
void	serialize (Streamer &s) override
void	setLatticeLength (double length)
void	setLatticeRotationAngle (double angle)
double	unitCellArea () const

Protected Attributes
DoubleProperty	m_latticeRotationAngle

Private Attributes
DoubleProperty	m_length

Constructor & Destructor Documentation

SquareLattice2DItem()

SquareLattice2DItem::SquareLattice2DItem

(

)

Definition at line 101 of file Lattice2DItems.cpp.

{
    m_length.init("LatticeLength", "Length of first and second lattice vectors", 20.0,
                  Unit::nanometer, "len");
}

References DoubleProperty::init(), m_length, and nanometer.

Here is the call graph for this function:

Member Function Documentation

createLattice()

std::unique_ptr< Lattice2D > SquareLattice2DItem::createLattice ( ) const

overridevirtual

Implements Lattice2DItem.

Definition at line 107 of file Lattice2DItems.cpp.

{
    return std::make_unique<SquareLattice2D>(m_length, Units::deg2rad(latticeRotationAngle()));
}

References Lattice2DItem::latticeRotationAngle(), and m_length.

Here is the call graph for this function:

geometryValues()

DoubleDescriptors SquareLattice2DItem::geometryValues ( bool  withRotationAngle ) const

inlineoverridevirtual

Implements Lattice2DItem.

Definition at line 80 of file Lattice2DItems.h.

    {
        if (withRotationAngle)
            return {m_length, m_latticeRotationAngle};
        return {m_length};
    }

References Lattice2DItem::m_latticeRotationAngle, and m_length.

latticeLength()

DoubleDescriptor SquareLattice2DItem::latticeLength

(

)

const

Definition at line 119 of file Lattice2DItems.cpp.

{
    return m_length;
}

References m_length.

latticeRotationAngle()

DoubleDescriptor Lattice2DItem::latticeRotationAngle ( ) const

inherited

Definition at line 33 of file Lattice2DItems.cpp.

{
    return m_latticeRotationAngle;
}

References Lattice2DItem::m_latticeRotationAngle.

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

serialize()

void SquareLattice2DItem::serialize ( Streamer &  s )

overridevirtual

Implements Lattice2DItem.

Definition at line 112 of file Lattice2DItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_latticeRotationAngle);
    Serialize::rwProperty(s, m_length);
}

References Streamer::assertVersion(), Lattice2DItem::m_latticeRotationAngle, m_length, and Serialize::rwProperty().

Here is the call graph for this function:

setLatticeLength()

void SquareLattice2DItem::setLatticeLength

(

double

length

)

Definition at line 124 of file Lattice2DItems.cpp.

{
    m_length.set(length);
}

References m_length, and DoubleProperty::set().

Here is the call graph for this function:

setLatticeRotationAngle()

void Lattice2DItem::setLatticeRotationAngle ( double  angle )

inherited

Definition at line 38 of file Lattice2DItems.cpp.

{
    m_latticeRotationAngle.set(angle);
}

References Lattice2DItem::m_latticeRotationAngle, and DoubleProperty::set().

Here is the call graph for this function:

unitCellArea()

double Lattice2DItem::unitCellArea ( ) const

inherited

Definition at line 28 of file Lattice2DItems.cpp.

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

References Lattice2DItem::createLattice().

Referenced by ParticleLayoutItem::totalDensityValue().

Here is the call graph for this function:

Member Data Documentation

m_latticeRotationAngle

DoubleProperty Lattice2DItem::m_latticeRotationAngle

protectedinherited

Definition at line 41 of file Lattice2DItems.h.

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

m_length

DoubleProperty SquareLattice2DItem::m_length

private

Definition at line 91 of file Lattice2DItems.h.

Referenced by SquareLattice2DItem(), createLattice(), geometryValues(), latticeLength(), serialize(), and setLatticeLength().

---

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