BackgroundItemCatalog Class Reference

Description

Definition at line 23 of file BackgroundItemCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = BackgroundItem
enum class	Type : uint8_t { None = 0 , Constant = 1 , Poission = 2 }

Static Public Member Functions
static BackgroundItem *	create (Type type)
	Creates the item of the given type. More...
static Type	type (const BackgroundItem *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 BackgroundItemCatalog::CatalogedType = BackgroundItem

Definition at line 25 of file BackgroundItemCatalog.h.

Member Enumeration Documentation

Type

enum BackgroundItemCatalog::Type : uint8_t

strong

Enumerator
None
Constant
Poission

Definition at line 28 of file BackgroundItemCatalog.h.

: uint8_t { None = 0, Constant = 1, Poission = 2 };

Member Function Documentation

create()

BackgroundItem * BackgroundItemCatalog::create ( Type  type )

static

Creates the item of the given type.

Definition at line 19 of file BackgroundItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return new NoBackgroundItem();
    case Type::Constant:
        return new ConstantBackgroundItem();
    case Type::Poission:
        return new PoissonBackgroundItem();
    }
    ASSERT(false);
}

References Constant, None, Poission, and type().

Here is the call graph for this function:

type()

BackgroundItemCatalog::Type BackgroundItemCatalog::type ( const BackgroundItem *  item )

static

Returns the enum type of the given item.

Definition at line 50 of file BackgroundItemCatalog.cpp.

{
    if (dynamic_cast<const NoBackgroundItem*>(item))
        return Type::None;
    if (dynamic_cast<const ConstantBackgroundItem*>(item))
        return Type::Constant;
    if (dynamic_cast<const PoissonBackgroundItem*>(item))
        return Type::Poission;
 
    ASSERT(false);
}

References Constant, None, and Poission.

Referenced by create(), and uiInfo().

types()

QVector< BackgroundItemCatalog::Type > BackgroundItemCatalog::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 32 of file BackgroundItemCatalog.cpp.

{
    return {Type::None, Type::Constant, Type::Poission};
}

References Constant, None, and Poission.

uiInfo()

BackgroundItemCatalog::UiInfo BackgroundItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 37 of file BackgroundItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return {"None", ""};
    case Type::Constant:
        return {"Constant background", ""};
    case Type::Poission:
        return {"Poisson noise", ""};
    }
    ASSERT(false);
}

References Constant, None, Poission, and type().

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