InterferenceItemCatalog Class Reference

Description

Definition at line 23 of file InterferenceItemCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = InterferenceItem
enum class	Type : uint8_t {   None = 0 , RadialParaCrystalRadial = 1 , ParaCrystal2D = 2 , Lattice1D = 3 ,   Lattice2D = 4 , FiniteLattice2D = 5 , HardDisk = 6 }

Static Public Member Functions
static InterferenceItem *	create (Type type)
	Creates the item of the given type. More...
static Type	type (const InterferenceItem *item)
	Returns the enum type of the given item. More...
static QVector< Type >	types ()
	Available types of interference items. More...
static UiInfo	uiInfo (Type t)
	UiInfo on the given type. More...

Member Typedef Documentation

CatalogedType

using InterferenceItemCatalog::CatalogedType = InterferenceItem

Definition at line 25 of file InterferenceItemCatalog.h.

Member Enumeration Documentation

Type

enum InterferenceItemCatalog::Type : uint8_t

strong

Enumerator
None
RadialParaCrystalRadial
ParaCrystal2D
Lattice1D
Lattice2D
FiniteLattice2D
HardDisk

Definition at line 28 of file InterferenceItemCatalog.h.

                    : uint8_t {
        None = 0,
        RadialParaCrystalRadial = 1,
        ParaCrystal2D = 2,
        Lattice1D = 3,
        Lattice2D = 4,
        FiniteLattice2D = 5,
        HardDisk = 6
    };

Member Function Documentation

create()

InterferenceItem * InterferenceItemCatalog::create ( Type  type )

static

Creates the item of the given type.

If type is "None", a nullptr is returned.

Definition at line 18 of file InterferenceItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return nullptr;
    case Type::RadialParaCrystalRadial:
        return new InterferenceRadialParaCrystalItem();
    case Type::ParaCrystal2D:
        return new Interference2DParaCrystalItem();
    case Type::Lattice1D:
        return new Interference1DLatticeItem();
    case Type::Lattice2D:
        return new Interference2DLatticeItem();
    case Type::FiniteLattice2D:
        return new InterferenceFinite2DLatticeItem();
    case Type::HardDisk:
        return new InterferenceHardDiskItem();
    default:
        ASSERT(false);
    }
}

References FiniteLattice2D, HardDisk, Lattice1D, Lattice2D, None, ParaCrystal2D, RadialParaCrystalRadial, and type().

Here is the call graph for this function:

type()

InterferenceItemCatalog::Type InterferenceItemCatalog::type ( const InterferenceItem *  item )

static

Returns the enum type of the given item.

Definition at line 75 of file InterferenceItemCatalog.cpp.

{
    if (!item)
        return Type::None;
 
    if (dynamic_cast<const InterferenceRadialParaCrystalItem*>(item))
        return Type::RadialParaCrystalRadial;
    if (dynamic_cast<const Interference2DParaCrystalItem*>(item))
        return Type::ParaCrystal2D;
    if (dynamic_cast<const Interference1DLatticeItem*>(item))
        return Type::Lattice1D;
    if (dynamic_cast<const Interference2DLatticeItem*>(item))
        return Type::Lattice2D;
    if (dynamic_cast<const InterferenceFinite2DLatticeItem*>(item))
        return Type::FiniteLattice2D;
    if (dynamic_cast<const InterferenceHardDiskItem*>(item))
        return Type::HardDisk;
 
    ASSERT(false);
}

References FiniteLattice2D, HardDisk, Lattice1D, Lattice2D, None, ParaCrystal2D, and RadialParaCrystalRadial.

Referenced by ParameterTreeBuilder::addInterference(), create(), and uiInfo().

types()

QVector< InterferenceItemCatalog::Type > InterferenceItemCatalog::types ( )

static

Available types of interference items.

Contains also type "None". This list is sorted as expected in the UI (e.g. in combo box)

Definition at line 40 of file InterferenceItemCatalog.cpp.

{
    return {Type::None,      Type::RadialParaCrystalRadial, Type::Lattice1D,
            Type::Lattice2D, Type::FiniteLattice2D,         Type::ParaCrystal2D,
            Type::HardDisk};
}

References FiniteLattice2D, HardDisk, Lattice1D, Lattice2D, None, ParaCrystal2D, and RadialParaCrystalRadial.

uiInfo()

InterferenceItemCatalog::UiInfo InterferenceItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 47 of file InterferenceItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return {"None", "", ""};
    case Type::RadialParaCrystalRadial:
        return {"Radial paracrystal", "Interference function of radial paracrystal",
                ":/SampleDesignerToolbox/images/ParaCrystal1D.png"};
    case Type::ParaCrystal2D:
        return {"2D paracrystal", "Interference function of two-dimensional paracrystal",
                ":/SampleDesignerToolbox/images/ParaCrystal2D.png"};
    case Type::Lattice1D:
        return {"1D lattice", "Interference function of 1D lattice",
                ":/SampleDesignerToolbox/images/Lattice1D.png"};
    case Type::Lattice2D:
        return {"2D lattice", "Interference function of 2D lattice",
                ":/SampleDesignerToolbox/images/Lattice2D.png"};
    case Type::FiniteLattice2D:
        return {"Finite 2D lattice", "Interference function of finite 2D lattice",
                ":/SampleDesignerToolbox/images/Lattice2DFinite.png"};
    case Type::HardDisk:
        return {"Hard disk Percus-Yevick", "Interference function for hard disk Percus-Yevick",
                ":/SampleDesignerToolbox/images/Lattice2D.png"};
    default:
        ASSERT(false);
    }
}

References FiniteLattice2D, HardDisk, Lattice1D, Lattice2D, None, ParaCrystal2D, RadialParaCrystalRadial, and type().

Referenced by ParameterTreeBuilder::addInterference().

Here is the call graph for this function:

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/InterferenceItemCatalog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/InterferenceItemCatalog.cpp