GroupInfo Class Reference

Defines info for GroupProperty, i.e. More...

Classes
struct	TypeAndLabel

Public Member Functions
	GroupInfo (const QString &groupType="", bool is_sorted=true)
void	add (const QString &itemType, const QString &itemLabel)
QString	defaultType () const
QString	groupType () const
bool	isValid ()
QStringList	itemLabels () const
QStringList	itemTypes () const
void	setDefaultType (const QString &modelType)

Private Member Functions
bool	containsType (const QString &itemType) const
	Default model type for given group (i.e. FFCylinder for formfactor group) More...

Private Attributes
bool	is_sorted
QString	m_defaultItemType
	Unique group name for GroupInfoCatalog. More...
QString	m_groupType
	Info will be sorted if true, otherwise order of insertion will be preserved. More...
QVector< TypeAndLabel >	m_info

Detailed Description

Defines info for GroupProperty, i.e.

collection of model types, their labels and the name of default item's modelType.

Definition at line 25 of file GroupInfo.h.

Constructor & Destructor Documentation

GroupInfo()

GroupInfo::GroupInfo ( const QString &  groupType = "", bool  is_sorted = true  )

explicit

Definition at line 18 of file GroupInfo.cpp.

    : m_groupType(groupType), is_sorted(is_sorted)
{
}

Member Function Documentation

add()

void GroupInfo::add	(	const QString &	itemType,
		const QString &	itemLabel
	)

Definition at line 23 of file GroupInfo.cpp.

{
    if (groupType().isEmpty())
        throw GUIHelpers::Error("GroupInfo::add() -> Error. Empty group name");
 
    if (containsType(itemType))
        throw GUIHelpers::Error("GroupInfo::add() -> Error. "
                                "Model type '"
                                + itemType + "' already exists.");
 
    m_info.push_back({itemType, itemLabel});
 
    if (is_sorted)
        std::sort(m_info.begin(), m_info.end(),
                  [](TypeAndLabel a, TypeAndLabel b) { return a.m_itemType < b.m_itemType; });
}

References containsType(), groupType(), is_sorted, and m_info.

Referenced by GroupInfoCatalog::GroupInfoCatalog().

Here is the call graph for this function:

containsType()

bool GroupInfo::containsType ( const QString &  itemType ) const

private

Default model type for given group (i.e. FFCylinder for formfactor group)

Definition at line 83 of file GroupInfo.cpp.

{
    for (auto& pair : m_info)
        if (itemType == pair.m_itemType)
            return true;
 
    return false;
}

References m_info.

Referenced by add(), and setDefaultType().

defaultType()

QString GroupInfo::defaultType

(

)

const

Definition at line 40 of file GroupInfo.cpp.

{
    if (m_defaultItemType == "" && m_info.size() != 0)
        return m_info[0].m_itemType;
    return m_defaultItemType;
}

References m_defaultItemType, and m_info.

Referenced by GroupItemController::GroupItemController().

groupType()

QString GroupInfo::groupType

(

)

const

Definition at line 55 of file GroupInfo.cpp.

{
    return m_groupType;
}

References m_groupType.

Referenced by add(), and GroupInfoCatalog::addInfo().

isValid()

bool GroupInfo::isValid

(

)

Definition at line 78 of file GroupInfo.cpp.

{
    return !m_groupType.isEmpty();
}

References m_groupType.

itemLabels()

QStringList GroupInfo::itemLabels

(

)

const

Definition at line 69 of file GroupInfo.cpp.

{
    QStringList result;
    for (auto& pair : m_info)
        result.append(pair.m_itemLabel);
 
    return result;
}

References m_info.

Referenced by GroupItemController::itemLabels().

itemTypes()

QStringList GroupInfo::itemTypes

(

)

const

Definition at line 60 of file GroupInfo.cpp.

{
    QStringList result;
    for (auto& pair : m_info)
        result.append(pair.m_itemType);
 
    return result;
}

References m_info.

Referenced by GroupItemController::itemTypes().

setDefaultType()

void GroupInfo::setDefaultType

(

const QString &

modelType

)

Definition at line 47 of file GroupInfo.cpp.

{
    if (!containsType(modelType))
        throw GUIHelpers::Error("GroupInfo::add() -> Error. No such type '" + modelType + "'");
 
    m_defaultItemType = modelType;
}

References containsType(), and m_defaultItemType.

Referenced by GroupInfoCatalog::GroupInfoCatalog().

Here is the call graph for this function:

Member Data Documentation

is_sorted

bool GroupInfo::is_sorted

private

Definition at line 55 of file GroupInfo.h.

Referenced by add().

m_defaultItemType

QString GroupInfo::m_defaultItemType

private

Unique group name for GroupInfoCatalog.

Definition at line 51 of file GroupInfo.h.

Referenced by defaultType(), and setDefaultType().

m_groupType

QString GroupInfo::m_groupType

private

Info will be sorted if true, otherwise order of insertion will be preserved.

Definition at line 53 of file GroupInfo.h.

Referenced by groupType(), and isValid().

m_info

QVector<TypeAndLabel> GroupInfo::m_info

private

Definition at line 56 of file GroupInfo.h.

Referenced by add(), containsType(), defaultType(), itemLabels(), and itemTypes().

---

The documentation for this class was generated from the following files:

• /home/www/ba/GUI/coregui/Models/GroupInfo.h
• /home/www/ba/GUI/coregui/Models/GroupInfo.cpp