DistributionItemCatalog Class Reference

Description

Definition at line 23 of file DistributionItemCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = DistributionItem
enum class	Type : uint8_t {   None = 0 , Gate = 1 , Lorentz = 2 , Gaussian = 3 ,   LogNormal = 4 , Cosine = 5 , Trapezoid = 6 }

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

Member Typedef Documentation

CatalogedType

using DistributionItemCatalog::CatalogedType = DistributionItem

Definition at line 25 of file DistributionItemCatalog.h.

Member Enumeration Documentation

Type

enum DistributionItemCatalog::Type : uint8_t

strong

Enumerator
None
Gate
Lorentz
Gaussian
LogNormal
Cosine
Trapezoid

Definition at line 28 of file DistributionItemCatalog.h.

                    : uint8_t {
        None = 0,
        Gate = 1,
        Lorentz = 2,
        Gaussian = 3,
        LogNormal = 4,
        Cosine = 5,
        Trapezoid = 6
    };

Member Function Documentation

create()

DistributionItem * DistributionItemCatalog::create ( Type  type )

static

Creates the item of the given type.

Definition at line 19 of file DistributionItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return new DistributionNoneItem();
    case Type::Gate:
        return new DistributionGateItem();
    case Type::Lorentz:
        return new DistributionLorentzItem();
    case Type::Gaussian:
        return new DistributionGaussianItem();
    case Type::LogNormal:
        return new DistributionLogNormalItem();
    case Type::Cosine:
        return new DistributionCosineItem();
    case Type::Trapezoid:
        return new DistributionTrapezoidItem();
    }
    ASSERT(false);
}

References Cosine, Gate, Gaussian, LogNormal, Lorentz, None, Trapezoid, and type().

Here is the call graph for this function:

symmetricTypes()

QVector< DistributionItemCatalog::Type > DistributionItemCatalog::symmetricTypes ( )

static

Types of symmetric distributions.

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

Definition at line 46 of file DistributionItemCatalog.cpp.

{
    return {Type::None, Type::Lorentz, Type::Gaussian, Type::Cosine};
}

References Cosine, Gaussian, Lorentz, and None.

Referenced by BeamWavelengthItem::BeamWavelengthItem(), and SpecularBeamInclinationItem::SpecularBeamInclinationItem().

type()

DistributionItemCatalog::Type DistributionItemCatalog::type ( const DistributionItem *  item )

static

Returns the enum type of the given item.

Definition at line 72 of file DistributionItemCatalog.cpp.

{
    if (dynamic_cast<const DistributionNoneItem*>(item))
        return Type::None;
    if (dynamic_cast<const DistributionGateItem*>(item))
        return Type::Gate;
    if (dynamic_cast<const DistributionLorentzItem*>(item))
        return Type::Lorentz;
    if (dynamic_cast<const DistributionGaussianItem*>(item))
        return Type::Gaussian;
    if (dynamic_cast<const DistributionLogNormalItem*>(item))
        return Type::LogNormal;
    if (dynamic_cast<const DistributionCosineItem*>(item))
        return Type::Cosine;
    if (dynamic_cast<const DistributionTrapezoidItem*>(item))
        return Type::Trapezoid;
 
    ASSERT(false);
}

References Cosine, Gate, Gaussian, LogNormal, Lorentz, None, and Trapezoid.

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

types()

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

static

Available types of 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 DistributionItemCatalog.cpp.

{
    return {Type::None,      Type::Gate,   Type::Lorentz,  Type::Gaussian,
            Type::LogNormal, Type::Cosine, Type::Trapezoid};
}

References Cosine, Gate, Gaussian, LogNormal, Lorentz, None, and Trapezoid.

Referenced by BeamAzimuthalAngleItem::BeamAzimuthalAngleItem(), BeamInclinationAngleItem::BeamInclinationAngleItem(), and BeamWavelengthItem::BeamWavelengthItem().

uiInfo()

DistributionItemCatalog::UiInfo DistributionItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 51 of file DistributionItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return {"None", "", ""};
    case Type::Gate:
        return {"Gate", "", ""};
    case Type::Lorentz:
        return {"Lorentz", "", ""};
    case Type::Gaussian:
        return {"Gaussian", "", ""};
    case Type::LogNormal:
        return {"Log Normal", "", ""};
    case Type::Cosine:
        return {"Cosine", "", ""};
    case Type::Trapezoid:
        return {"Trapezoid", "", ""};
    }
    ASSERT(false);
}

References Cosine, Gate, Gaussian, LogNormal, Lorentz, None, Trapezoid, and type().

Referenced by ParameterTreeBuilder::addBeamDistribution().

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/CatDevice/DistributionItemCatalog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatDevice/DistributionItemCatalog.cpp