Profile1DItemCatalog Class Reference

Description

Definition at line 24 of file ProfileItemCatalogs.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = Profile1DItem
enum class	Type : uint8_t {   Cauchy = 1 , Gauss = 2 , Gate = 3 , Triangle = 4 ,   Cosine = 5 , Voigt = 6 }

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 Profile1DItemCatalog::CatalogedType = Profile1DItem

Definition at line 26 of file ProfileItemCatalogs.h.

Member Enumeration Documentation

Type

enum Profile1DItemCatalog::Type : uint8_t

strong

Enumerator
Cauchy
Gauss
Gate
Triangle
Cosine
Voigt

Definition at line 29 of file ProfileItemCatalogs.h.

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

Member Function Documentation

create()

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

static

Creates the item of the given type.

Definition at line 19 of file ProfileItemCatalogs.cpp.

{
    switch (type) {
    case Type::Cauchy:
        return new Profile1DCauchyItem();
    case Type::Gauss:
        return new Profile1DGaussItem();
    case Type::Gate:
        return new Profile1DGateItem();
    case Type::Triangle:
        return new Profile1DTriangleItem();
    case Type::Cosine:
        return new Profile1DCosineItem();
    case Type::Voigt:
        return new Profile1DVoigtItem();
    default:
        ASSERT(false);
    }
}

References Cauchy, Cosine, Gate, Gauss, Triangle, type(), and Voigt.

Here is the call graph for this function:

type()

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

static

Returns the enum type of the given item.

Definition at line 64 of file ProfileItemCatalogs.cpp.

{
    ASSERT(item);
 
#define CHECK(type)                                                                                \
    if (dynamic_cast<const Profile1D##type##Item*>(item))                                          \
    return Type::type
 
    CHECK(Cauchy);
    CHECK(Gauss);
    CHECK(Gate);
    CHECK(Triangle);
    CHECK(Cosine);
    CHECK(Voigt);
#undef CHECK
 
    ASSERT(false);
}

References CHECK.

Referenced by create(), and uiInfo().

types()

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

static

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

Definition at line 39 of file ProfileItemCatalogs.cpp.

{
    return {Type::Cauchy, Type::Gauss, Type::Gate, Type::Triangle, Type::Cosine, Type::Voigt};
}

References Cauchy, Cosine, Gate, Gauss, Triangle, and Voigt.

uiInfo()

Profile1DItemCatalog::UiInfo Profile1DItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 44 of file ProfileItemCatalogs.cpp.

{
    switch (type) {
    case Type::Cauchy:
        return {"Cauchy 1D", "One-dimensional Cauchy probability distribution", ""};
    case Type::Gauss:
        return {"Gauss 1D", "One-dimensional Gauss probability distribution", ""};
    case Type::Gate:
        return {"Gate 1D", "One-dimensional Gate probability distribution", ""};
    case Type::Triangle:
        return {"Triangle 1D", "One-dimensional triangle probability distribution", ""};
    case Type::Cosine:
        return {"Cosine 1D", "One-dimensional Cosine probability distribution", ""};
    case Type::Voigt:
        return {"Voigt 1D", "One-dimensional pseudo-Voigt probability distribution", ""};
    default:
        ASSERT(false);
    }
}

References Cauchy, Cosine, Gate, Gauss, Triangle, 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