Lattice2DItemCatalog Class Reference

Description

Definition at line 23 of file Lattice2DItemCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = Lattice2DItem
enum class	Type : uint8_t { Basic = 1 , Square = 2 , Hexagonal }

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 Lattice2DItemCatalog::CatalogedType = Lattice2DItem

Definition at line 25 of file Lattice2DItemCatalog.h.

Member Enumeration Documentation

Type

enum Lattice2DItemCatalog::Type : uint8_t

strong

Enumerator
Basic
Square
Hexagonal

Definition at line 28 of file Lattice2DItemCatalog.h.

: uint8_t { Basic = 1, Square = 2, Hexagonal };

Member Function Documentation

create()

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

static

Creates the item of the given type.

Definition at line 19 of file Lattice2DItemCatalog.cpp.

{
    switch (type) {
    case Type::Basic:
        return new BasicLattice2DItem();
    case Type::Square:
        return new SquareLattice2DItem();
    case Type::Hexagonal:
        return new HexagonalLattice2DItem();
    default:
        ASSERT(false);
    }
}

References Basic, Hexagonal, Square, and type().

Here is the call graph for this function:

type()

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

static

Returns the enum type of the given item.

Definition at line 52 of file Lattice2DItemCatalog.cpp.

{
    ASSERT(item);
 
    if (dynamic_cast<const BasicLattice2DItem*>(item))
        return Type::Basic;
    if (dynamic_cast<const SquareLattice2DItem*>(item))
        return Type::Square;
    if (dynamic_cast<const HexagonalLattice2DItem*>(item))
        return Type::Hexagonal;
 
    ASSERT(false);
}

References Basic, Hexagonal, and Square.

Referenced by create(), and uiInfo().

types()

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

static

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

Definition at line 33 of file Lattice2DItemCatalog.cpp.

{
    return {Type::Basic, Type::Square, Type::Hexagonal};
}

References Basic, Hexagonal, and Square.

uiInfo()

Lattice2DItemCatalog::UiInfo Lattice2DItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 38 of file Lattice2DItemCatalog.cpp.

{
    switch (type) {
    case Type::Basic:
        return {"Basic", "Two dimensional lattice", ""};
    case Type::Square:
        return {"Square", "", ""};
    case Type::Hexagonal:
        return {"Hexagonal", "", ""};
    default:
        ASSERT(false);
    }
}

References Basic, Hexagonal, 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/CatSample/Lattice2DItemCatalog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/Lattice2DItemCatalog.cpp