SessionItemTags Class Reference

Description

Holds all tag info for SessionItem.

Definition at line 24 of file SessionItemTags.h.

Classes
struct	TagInfo

Public Member Functions
void	addChild (const QString &tagName)
int	childCount (const QString &tagName)
int	childMax (const QString &tagName)
int	indexFromTagRow (const QString &tagName, int row) const
	Returns index in SessionItem's m_children corresponding to given row in tagName. More...
int	insertIndexFromTagRow (const QString &tagName, int row)
	Returns index in SessionItem's m_children to insert new item. If number of items for given tagName exceeds maximum allowed, returns -1;. More...
bool	isSingleItemTag (const QString &tagName) const
bool	isValid (const QString &tagName, const QString &modelType="") const
	Returns true if there is a registered tag with such name. If modelType is not empty, than an additional check is performed if tag is intended for the given modelType. More...
bool	maximumReached (const QString &tagName) const
QStringList	modelTypesForTag (const QString &tagName) const
	Returns list of modelTypes the given tagName is intended for. More...
bool	registerTag (const QString &name, int min, int max, const QStringList &modelTypes)
	Register tag with given parameters. Returns true in case of success. Returns false if parameters are invalid or such tag was already registered. More...
void	removeChild (const QString &tagName)
QString	tagFromIndex (int index) const
int	tagStartIndex (const QString &tagName) const
	Returns start index of given tagName corresponding to the index of SessionItem's m_children. More...

Private Member Functions
TagInfo &	tagInfo (const QString &tagName)
const TagInfo &	tagInfo (const QString &tagName) const

Private Attributes
QVector< TagInfo >	m_tags

Member Function Documentation

addChild()

void SessionItemTags::addChild

(

const QString &

tagName

)

Definition at line 113 of file SessionItemTags.cpp.

{
    ASSERT(!maximumReached(tagName));
    tagInfo(tagName).childCount++;
}

References SessionItemTags::TagInfo::childCount, maximumReached(), and tagInfo().

Here is the call graph for this function:

childCount()

int SessionItemTags::childCount

(

const QString &

tagName

)

Definition at line 103 of file SessionItemTags.cpp.

{
    return tagInfo(tagName).childCount;
}

References SessionItemTags::TagInfo::childCount, and tagInfo().

Referenced by indexFromTagRow().

Here is the call graph for this function:

childMax()

int SessionItemTags::childMax

(

const QString &

tagName

)

Definition at line 108 of file SessionItemTags.cpp.

{
    return tagInfo(tagName).max;
}

References SessionItemTags::TagInfo::max, and tagInfo().

Here is the call graph for this function:

indexFromTagRow()

int SessionItemTags::indexFromTagRow	(	const QString &	tagName,
		int	row
	)		const

Returns index in SessionItem's m_children corresponding to given row in tagName.

Definition at line 70 of file SessionItemTags.cpp.

{
    ASSERT(row >= 0 && row < tagInfo(tagName).childCount);
    return tagStartIndex(tagName) + row;
}

References childCount(), tagInfo(), and tagStartIndex().

Here is the call graph for this function:

insertIndexFromTagRow()

int SessionItemTags::insertIndexFromTagRow	(	const QString &	tagName,
		int	row
	)

Returns index in SessionItem's m_children to insert new item. If number of items for given tagName exceeds maximum allowed, returns -1;.

Definition at line 79 of file SessionItemTags.cpp.

{
    if (maximumReached(tagName))
        return -1;
    auto& tag = tagInfo(tagName);
    if (row > tag.childCount)
        return -1;
    if (row < 0)
        row = tag.childCount;
    return tagStartIndex(tagName) + row;
}

References maximumReached(), tagInfo(), and tagStartIndex().

Here is the call graph for this function:

isSingleItemTag()

bool SessionItemTags::isSingleItemTag

(

const QString &

tagName

)

const

Definition at line 126 of file SessionItemTags.cpp.

{
    if (!isValid(tagName))
        return false;
    const auto& tag = tagInfo(tagName);
    return tag.min == 1 && tag.max == 1 && tag.childCount == 1;
}

References isValid(), and tagInfo().

Referenced by SessionItem::displayName().

Here is the call graph for this function:

isValid()

bool SessionItemTags::isValid	(	const QString &	tagName,
		const QString &	modelType = ""
	)		const

Returns true if there is a registered tag with such name. If modelType is not empty, than an additional check is performed if tag is intended for the given modelType.

Definition at line 36 of file SessionItemTags.cpp.

{
    for (const auto& tag : m_tags) {
        if (tag.name == tagName) {
            if (modelType.isEmpty())
                return true;
            return tag.modelTypes.isEmpty() ? true : tag.modelTypes.contains(modelType);
        }
    }
    return false;
}

References m_tags.

Referenced by SessionModel::insertNewItem(), isSingleItemTag(), modelTypesForTag(), SessionModel::moveItem(), and registerTag().

maximumReached()

bool SessionItemTags::maximumReached

(

const QString &

tagName

)

const

Definition at line 147 of file SessionItemTags.cpp.

{
    const auto& tag = tagInfo(tagName);
    return tag.max != -1 && tag.max == tag.childCount;
}

References tagInfo().

Referenced by addChild(), insertIndexFromTagRow(), and SessionModel::moveItem().

Here is the call graph for this function:

modelTypesForTag()

QStringList SessionItemTags::modelTypesForTag

(

const QString &

tagName

)

const

Returns list of modelTypes the given tagName is intended for.

Definition at line 50 of file SessionItemTags.cpp.

{
    return isValid(tagName) ? tagInfo(tagName).modelTypes : QStringList();
}

References isValid(), SessionItemTags::TagInfo::modelTypes, and tagInfo().

Here is the call graph for this function:

registerTag()

bool SessionItemTags::registerTag	(	const QString &	name,
		int	min,
		int	max,
		const QStringList &	modelTypes
	)

Register tag with given parameters. Returns true in case of success. Returns false if parameters are invalid or such tag was already registered.

Definition at line 21 of file SessionItemTags.cpp.

{
    if (min < 0 || (min > max && max >= 0))
        return false;
    if (name.isEmpty() || isValid(name))
        return false;
    m_tags.push_back({name, min, max, 0, modelTypes});
    return true;
}

References isValid(), m_tags, and GUI::RealSpace::Particles::name().

Here is the call graph for this function:

removeChild()

void SessionItemTags::removeChild

(

const QString &

tagName

)

Definition at line 119 of file SessionItemTags.cpp.

{
    auto& tag = tagInfo(tagName);
    ASSERT(tag.childCount > 0);
    tag.childCount--;
}

References tagInfo().

Here is the call graph for this function:

tagFromIndex()

QString SessionItemTags::tagFromIndex

(

int

index

)

const

Definition at line 91 of file SessionItemTags.cpp.

{
    if (index < 0)
        return "";
    for (const auto& tag : m_tags) {
        if (index < tag.childCount)
            return tag.name;
        index -= tag.childCount;
    }
    return "";
}

References m_tags.

tagInfo() [1/2]

SessionItemTags::TagInfo & SessionItemTags::tagInfo ( const QString &  tagName )

private

Definition at line 134 of file SessionItemTags.cpp.

{
    return const_cast<TagInfo&>(static_cast<const SessionItemTags*>(this)->tagInfo(tagName));
}

Referenced by addChild(), childCount(), childMax(), indexFromTagRow(), insertIndexFromTagRow(), isSingleItemTag(), maximumReached(), modelTypesForTag(), and removeChild().

tagInfo() [2/2]

const SessionItemTags::TagInfo & SessionItemTags::tagInfo ( const QString &  tagName ) const

private

Definition at line 139 of file SessionItemTags.cpp.

{
    for (const auto& tag : m_tags)
        if (tag.name == tagName)
            return tag;
    ASSERT(0);
}

References m_tags.

tagStartIndex()

int SessionItemTags::tagStartIndex

(

const QString &

tagName

)

const

Returns start index of given tagName corresponding to the index of SessionItem's m_children.

Definition at line 57 of file SessionItemTags.cpp.

{
    int index(0);
    for (const auto& tag : m_tags) {
        if (tag.name == tagName)
            return index;
        index += tag.childCount;
    }
    ASSERT(0);
}

References m_tags.

Referenced by indexFromTagRow(), and insertIndexFromTagRow().

Member Data Documentation

m_tags

QVector<TagInfo> SessionItemTags::m_tags

private

Definition at line 61 of file SessionItemTags.h.

Referenced by isValid(), registerTag(), tagFromIndex(), tagInfo(), and tagStartIndex().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/Data/SessionItemTags.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/Data/SessionItemTags.cpp