Profile2DItemCatalog Class Reference

Description

Definition at line 57 of file ProfileItemCatalogs.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = Profile2DItem
enum class	Type : uint8_t {   Cauchy = 1 , Gauss = 2 , Gate = 3 , Cone = 4 ,   Voigt = 5 }

Static Public Member Functions
static CatalogedType *	create (Type type)
	Creates the item of the given type. More...
static Type	type (const CatalogedType *item)
	Returns the enum type of the given item. More...
static QVector< Type >	types ()
	List of available types, sorted as expected in the UI. More...
static UiInfo	uiInfo (Type t)
	UiInfo on the given type. More...

Member Typedef Documentation

CatalogedType

using Profile2DItemCatalog::CatalogedType = Profile2DItem

Definition at line 59 of file ProfileItemCatalogs.h.

Member Enumeration Documentation

Type

enum Profile2DItemCatalog::Type : uint8_t

strong

Enumerator
Cauchy
Gauss
Gate
Cone
Voigt

Definition at line 62 of file ProfileItemCatalogs.h.

: uint8_t { Cauchy = 1, Gauss = 2, Gate = 3, Cone = 4, Voigt = 5 };

Member Function Documentation

create()

Profile2DItemCatalog::CatalogedType * Profile2DItemCatalog::create ( Type  type )

static

Creates the item of the given type.

Definition at line 85 of file ProfileItemCatalogs.cpp.

{
    switch (type) {
    case Type::Cauchy:
        return new Profile2DCauchyItem();
    case Type::Gauss:
        return new Profile2DGaussItem();
    case Type::Gate:
        return new Profile2DGateItem();
    case Type::Cone:
        return new Profile2DConeItem();
    case Type::Voigt:
        return new Profile2DVoigtItem();
    default:
        ASSERT(false);
    }
}

References Cauchy, Cone, Gate, Gauss, type(), and Voigt.

Here is the call graph for this function:

type()

Profile2DItemCatalog::Type Profile2DItemCatalog::type ( const CatalogedType *  item )

static

Returns the enum type of the given item.

Definition at line 126 of file ProfileItemCatalogs.cpp.

{
    ASSERT(item);
 
    if (dynamic_cast<const Profile2DCauchyItem*>(item))
        return Type::Cauchy;
    if (dynamic_cast<const Profile2DGaussItem*>(item))
        return Type::Gauss;
    if (dynamic_cast<const Profile2DGateItem*>(item))
        return Type::Gate;
    if (dynamic_cast<const Profile2DConeItem*>(item))
        return Type::Cone;
    if (dynamic_cast<const Profile2DVoigtItem*>(item))
        return Type::Voigt;
 
    ASSERT(false);
}

References Cauchy, Cone, Gate, Gauss, and Voigt.

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

types()

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

static

List of available types, sorted as expected in the UI.

Definition at line 103 of file ProfileItemCatalogs.cpp.

{
    return {Type::Cauchy, Type::Gauss, Type::Gate, Type::Cone, Type::Voigt};
}

References Cauchy, Cone, Gate, Gauss, and Voigt.

uiInfo()

Profile2DItemCatalog::UiInfo Profile2DItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 108 of file ProfileItemCatalogs.cpp.

{
    switch (type) {
    case Type::Cauchy:
        return {"Cauchy 2D", "Two-dimensional Cauchy probability distribution", ""};
    case Type::Gauss:
        return {"Gauss 2D", "Two-dimensional Gauss probability distribution", ""};
    case Type::Gate:
        return {"Gate 2D", "Two-dimensional Gate probability distribution", ""};
    case Type::Cone:
        return {"Cone 2D", "Two-dimensional Cone probability distribution", ""};
    case Type::Voigt:
        return {"Voigt 2D", "Two-dimensional pseudo-Voigt probability distribution", ""};
    default:
        ASSERT(false);
    }
}

References Cauchy, Cone, Gate, Gauss, type(), and Voigt.

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