FootprintItemCatalog Class Reference

Description

Definition at line 23 of file FootprintItemCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = FootprintItem
enum class	Type : uint8_t { None = 0 , Gaussian = 1 , Square = 2 }

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

Definition at line 25 of file FootprintItemCatalog.h.

Member Enumeration Documentation

Type

enum FootprintItemCatalog::Type : uint8_t

strong

Enumerator
None
Gaussian
Square

Definition at line 28 of file FootprintItemCatalog.h.

: uint8_t { None = 0, Gaussian = 1, Square = 2 };

Member Function Documentation

create()

FootprintItem * FootprintItemCatalog::create ( Type  type )

static

Creates the item of the given type.

Definition at line 19 of file FootprintItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return new FootprintNoneItem();
    case Type::Gaussian:
        return new FootprintGaussianItem();
    case Type::Square:
        return new FootprintSquareItem();
    }
    ASSERT(false);
}

References Gaussian, None, Square, and type().

Here is the call graph for this function:

type()

FootprintItemCatalog::Type FootprintItemCatalog::type ( const FootprintItem *  item )

static

Returns the enum type of the given item.

Definition at line 50 of file FootprintItemCatalog.cpp.

{
    if (dynamic_cast<const FootprintNoneItem*>(item))
        return Type::None;
    if (dynamic_cast<const FootprintGaussianItem*>(item))
        return Type::Gaussian;
    if (dynamic_cast<const FootprintSquareItem*>(item))
        return Type::Square;
 
    ASSERT(false);
}

References Gaussian, None, and Square.

Referenced by create(), and uiInfo().

types()

QVector< FootprintItemCatalog::Type > FootprintItemCatalog::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 FootprintItemCatalog.cpp.

{
    return {Type::None, Type::Gaussian, Type::Square};
}

References Gaussian, None, and Square.

uiInfo()

FootprintItemCatalog::UiInfo FootprintItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 37 of file FootprintItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return {"None", ""};
    case Type::Gaussian:
        return {"Gaussian footprint", ""};
    case Type::Square:
        return {"Square footprint", ""};
    }
    ASSERT(false);
}

References Gaussian, None, Square, 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/FootprintItemCatalog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatDevice/FootprintItemCatalog.cpp