BasicLattice2DItem Class Reference

Description

Definition at line 46 of file Lattice2DItems.h.

Inheritance diagram for BasicLattice2DItem:

Collaboration diagram for BasicLattice2DItem:

Public Member Functions
	BasicLattice2DItem ()
std::unique_ptr< Lattice2D >	createLattice () const override
DoubleDescriptors	geometryValues (bool withRotationAngle) const override
DoubleDescriptor	latticeAngle () const
DoubleDescriptor	latticeLength1 () const
DoubleDescriptor	latticeLength2 () const
DoubleDescriptor	latticeRotationAngle () const
void	serialize (Streamer &s) override
void	setLatticeAngle (double angle)
void	setLatticeLength1 (double length1)
void	setLatticeLength2 (double length2)
void	setLatticeRotationAngle (double angle)
double	unitCellArea () const

Protected Attributes
DoubleProperty	m_latticeRotationAngle

Private Attributes
DoubleProperty	m_angle
DoubleProperty	m_length1
DoubleProperty	m_length2

Constructor & Destructor Documentation

BasicLattice2DItem()

BasicLattice2DItem::BasicLattice2DItem

(

)

Definition at line 45 of file Lattice2DItems.cpp.

{
    m_length1.init("LatticeLength1", "Length of first lattice vector", 20.0, Unit::nanometer,
                   "len1");
    m_length2.init("LatticeLength2", "Length of second lattice vector", 20.0, Unit::nanometer,
                   "len2");
    m_angle.init("Angle", "Angle between lattice vectors", 90.0, Unit::degree, "angle");
}

References degree, DoubleProperty::init(), m_angle, m_length1, m_length2, and nanometer.

Here is the call graph for this function:

Member Function Documentation

createLattice()

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

overridevirtual

Implements Lattice2DItem.

Definition at line 54 of file Lattice2DItems.cpp.

{
    return std::make_unique<BasicLattice2D>(m_length1, m_length2, Units::deg2rad(m_angle),
                                            Units::deg2rad(latticeRotationAngle()));
}

References Lattice2DItem::latticeRotationAngle(), m_angle, m_length1, and m_length2.

Here is the call graph for this function:

geometryValues()

DoubleDescriptors BasicLattice2DItem::geometryValues ( bool  withRotationAngle ) const

inlineoverridevirtual

Implements Lattice2DItem.

Definition at line 51 of file Lattice2DItems.h.

    {
        if (withRotationAngle)
            return {m_length1, m_length2, m_angle, m_latticeRotationAngle};
        return {m_length1, m_length2, m_angle};
    }

References m_angle, Lattice2DItem::m_latticeRotationAngle, m_length1, and m_length2.

latticeAngle()

DoubleDescriptor BasicLattice2DItem::latticeAngle

(

)

const

Definition at line 89 of file Lattice2DItems.cpp.

{
    return m_angle;
}

References m_angle.

latticeLength1()

DoubleDescriptor BasicLattice2DItem::latticeLength1

(

)

const

Definition at line 69 of file Lattice2DItems.cpp.

{
    return m_length1;
}

References m_length1.

latticeLength2()

DoubleDescriptor BasicLattice2DItem::latticeLength2

(

)

const

Definition at line 79 of file Lattice2DItems.cpp.

{
    return m_length2;
}

References m_length2.

latticeRotationAngle()

DoubleDescriptor Lattice2DItem::latticeRotationAngle ( ) const

inherited

Definition at line 33 of file Lattice2DItems.cpp.

{
    return m_latticeRotationAngle;
}

References Lattice2DItem::m_latticeRotationAngle.

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

serialize()

void BasicLattice2DItem::serialize ( Streamer &  s )

overridevirtual

Implements Lattice2DItem.

Definition at line 60 of file Lattice2DItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_latticeRotationAngle);
    Serialize::rwProperty(s, m_length1);
    Serialize::rwProperty(s, m_length2);
    Serialize::rwProperty(s, m_angle);
}

References Streamer::assertVersion(), m_angle, Lattice2DItem::m_latticeRotationAngle, m_length1, m_length2, and Serialize::rwProperty().

Here is the call graph for this function:

setLatticeAngle()

void BasicLattice2DItem::setLatticeAngle

(

double

angle

)

Definition at line 94 of file Lattice2DItems.cpp.

{
    m_angle.set(angle);
}

References m_angle, and DoubleProperty::set().

Here is the call graph for this function:

setLatticeLength1()

void BasicLattice2DItem::setLatticeLength1

(

double

length1

)

Definition at line 74 of file Lattice2DItems.cpp.

{
    m_length1.set(length1);
}

References m_length1, and DoubleProperty::set().

Here is the call graph for this function:

setLatticeLength2()

void BasicLattice2DItem::setLatticeLength2

(

double

length2

)

Definition at line 84 of file Lattice2DItems.cpp.

{
    m_length2.set(length2);
}

References m_length2, 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_angle

DoubleProperty BasicLattice2DItem::m_angle

private

Definition at line 70 of file Lattice2DItems.h.

Referenced by BasicLattice2DItem(), createLattice(), geometryValues(), latticeAngle(), serialize(), and setLatticeAngle().

m_latticeRotationAngle

DoubleProperty Lattice2DItem::m_latticeRotationAngle

protectedinherited

Definition at line 41 of file Lattice2DItems.h.

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

m_length1

DoubleProperty BasicLattice2DItem::m_length1

private

Definition at line 68 of file Lattice2DItems.h.

Referenced by BasicLattice2DItem(), createLattice(), geometryValues(), latticeLength1(), serialize(), and setLatticeLength1().

m_length2

DoubleProperty BasicLattice2DItem::m_length2

private

Definition at line 69 of file Lattice2DItems.h.

Referenced by BasicLattice2DItem(), createLattice(), geometryValues(), latticeLength2(), serialize(), and setLatticeLength2().

---

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