Lattice2DItems.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Sample/Lattice2DItems.h
//! @brief     Defines classes Lattice2DItems
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_SAMPLE_LATTICE2DITEMS_H
#define BORNAGAIN_GUI_MODEL_SAMPLE_LATTICE2DITEMS_H
 
#include "GUI/Model/Descriptor/DoubleProperty.h"
#include <QVector>
#include <memory>
 
class Lattice2D;
class DoubleDescriptor;
class Streamer;
 
class Lattice2DItem {
protected:
    Lattice2DItem();
 
public:
    virtual ~Lattice2DItem() = default;
    virtual std::unique_ptr<Lattice2D> createLattice() const = 0;
    virtual DoubleDescriptors geometryValues(bool withRotationAngle) const = 0;
    virtual void serialize(Streamer& s) = 0;
    double unitCellArea() const;
 
    DoubleDescriptor latticeRotationAngle() const;
    void setLatticeRotationAngle(double angle);
 
protected:
    DoubleProperty m_latticeRotationAngle;
};
 
// -------------------------------------------------------------------------------------
 
class BasicLattice2DItem : public Lattice2DItem {
public:
    BasicLattice2DItem();
    std::unique_ptr<Lattice2D> createLattice() const override;
    void serialize(Streamer& s) override;
    DoubleDescriptors geometryValues(bool withRotationAngle) const override
    {
        if (withRotationAngle)
            return {m_length1, m_length2, m_angle, m_latticeRotationAngle};
        return {m_length1, m_length2, m_angle};
    }
 
    DoubleDescriptor latticeLength1() const;
    void setLatticeLength1(double length1);
 
    DoubleDescriptor latticeLength2() const;
    void setLatticeLength2(double length2);
 
    DoubleDescriptor latticeAngle() const;
    void setLatticeAngle(double angle);
 
private:
    DoubleProperty m_length1;
    DoubleProperty m_length2;
    DoubleProperty m_angle;
};
 
// -------------------------------------------------------------------------------------
 
class SquareLattice2DItem : public Lattice2DItem {
public:
    SquareLattice2DItem();
    std::unique_ptr<Lattice2D> createLattice() const override;
    void serialize(Streamer& s) override;
    DoubleDescriptors geometryValues(bool withRotationAngle) const override
    {
        if (withRotationAngle)
            return {m_length, m_latticeRotationAngle};
        return {m_length};
    }
 
    DoubleDescriptor latticeLength() const;
    void setLatticeLength(double length);
 
private:
    DoubleProperty m_length;
};
 
// -------------------------------------------------------------------------------------
 
class HexagonalLattice2DItem : public Lattice2DItem {
public:
    HexagonalLattice2DItem();
    std::unique_ptr<Lattice2D> createLattice() const override;
    void serialize(Streamer& s) override;
    DoubleDescriptors geometryValues(bool withRotationAngle) const override
    {
        if (withRotationAngle)
            return {m_length, m_latticeRotationAngle};
        return {m_length};
    }
 
    DoubleDescriptor latticeLength() const;
    void setLatticeLength(double length);
 
private:
    DoubleProperty m_length;
};
 
#endif // BORNAGAIN_GUI_MODEL_SAMPLE_LATTICE2DITEMS_H