ModelView::SessionItemContainer Class Reference

Holds collection of SessionItem objects related to the same tag. More...

Collaboration diagram for ModelView::SessionItemContainer:

Public Types
using	const_iterator = container_t::const_iterator
using	container_t = std::vector< SessionItem * >

Public Member Functions
	SessionItemContainer (const SessionItemContainer &)=delete
	SessionItemContainer (TagInfo tag_info)
	~SessionItemContainer ()
const_iterator	begin () const
bool	canInsertItem (const SessionItem *item, int index) const
	Returns true if given item can be inserted under given index. More...
bool	canTakeItem (int index) const
	Returns true if item can be taken. More...
bool	empty () const
const_iterator	end () const
int	indexOfItem (const SessionItem *item) const
	Returns index of item in vector of items. More...
bool	insertItem (SessionItem *item, int index)
	Inserts item in a vector of children at given index, returns true in the case of success. More...
SessionItem *	itemAt (int index) const
	Returns item at given index. Returns nullptr if index is invalid. More...
int	itemCount () const
	Returns number of items in given tag. More...
std::vector< SessionItem * >	items () const
	Returns vector of items in this container. More...
std::string	name () const
	Returns the name of SessionItemTag. More...
SessionItemContainer &	operator= (const SessionItemContainer &)=delete
TagInfo	tagInfo () const
SessionItem *	takeItem (int index)
	Removes item at given index and returns it to the user. More...

Private Member Functions
bool	is_valid_item (const SessionItem *item) const
	Returns true if item's modelType is intended for this tag. More...
bool	maximum_reached () const
	Returns true if no more items are allowed. More...
bool	minimum_reached () const
	Returns true if less items than now is not allowed. More...

Private Attributes
container_t	m_items
TagInfo	m_tag_info

Detailed Description

Holds collection of SessionItem objects related to the same tag.

Definition at line 28 of file sessionitemcontainer.h.

Member Typedef Documentation

const_iterator

using ModelView::SessionItemContainer::const_iterator = container_t::const_iterator

Definition at line 31 of file sessionitemcontainer.h.

container_t

using ModelView::SessionItemContainer::container_t = std::vector<SessionItem*>

Definition at line 30 of file sessionitemcontainer.h.

Constructor & Destructor Documentation

SessionItemContainer() [1/2]

SessionItemContainer::SessionItemContainer

(

ModelView::TagInfo

tag_info

)

Definition at line 21 of file sessionitemcontainer.cpp.

    : m_tag_info(std::move(tag_info))
{
}

SessionItemContainer() [2/2]

ModelView::SessionItemContainer::SessionItemContainer ( const SessionItemContainer &  )

delete

~SessionItemContainer()

SessionItemContainer::~SessionItemContainer

(

)

Definition at line 26 of file sessionitemcontainer.cpp.

{
    for (auto item : m_items)
        delete item;
}

References m_items.

Member Function Documentation

begin()

SessionItemContainer::const_iterator SessionItemContainer::begin

(

)

const

Definition at line 126 of file sessionitemcontainer.cpp.

{
    return m_items.begin();
}

References m_items.

canInsertItem()

bool SessionItemContainer::canInsertItem	(	const SessionItem *	item,
		int	index
	)		const

Returns true if given item can be inserted under given index.

Definition at line 92 of file sessionitemcontainer.cpp.

{
    const bool valid_index = (index >= 0 && index <= itemCount());
    const bool enough_place = !maximum_reached();
    return valid_index && enough_place && is_valid_item(item);
}

References is_valid_item(), itemCount(), and maximum_reached().

Referenced by insertItem(), and TEST_F().

Here is the call graph for this function:

canTakeItem()

bool SessionItemContainer::canTakeItem

(

int

index

)

const

Returns true if item can be taken.

Definition at line 85 of file sessionitemcontainer.cpp.

{
    return itemAt(index) && !minimum_reached();
}

References itemAt(), and minimum_reached().

Referenced by ModelView::SessionItemTags::canTakeItem(), and TEST_F().

Here is the call graph for this function:

empty()

bool SessionItemContainer::empty

(

)

const

Definition at line 32 of file sessionitemcontainer.cpp.

{
    return m_items.empty();
}

References m_items.

Referenced by ModelView::SessionItemTags::container(), ModelView::JsonItemContainerConverter::from_json(), ModelView::JsonItemContainerConverter::JsonItemContainerConverterImpl::populate_container(), and TEST_F().

end()

SessionItemContainer::const_iterator SessionItemContainer::end

(

)

const

Definition at line 131 of file sessionitemcontainer.cpp.

{
    return m_items.end();
}

References m_items.

indexOfItem()

int SessionItemContainer::indexOfItem

(

const SessionItem *

item

)

const

Returns index of item in vector of items.

Returns -1 if item doesn't belong to us.

Definition at line 102 of file sessionitemcontainer.cpp.

{
    return Utils::IndexOfItem(m_items, item);
}

References ModelView::Utils::IndexOfItem(), and m_items.

Referenced by TEST_F().

Here is the call graph for this function:

insertItem()

bool SessionItemContainer::insertItem	(	SessionItem *	item,
		int	index
	)

Inserts item in a vector of children at given index, returns true in the case of success.

Parameters

item	Item to be inserted, ownership will be taken.
index	Item insert index in a range [0, itemCount]

Insert index is an index which item will have after insertion. If item can't be inserted (wrong model type, wrong index or maximum number of items reached), will return false.

Definition at line 60 of file sessionitemcontainer.cpp.

{
    if (!canInsertItem(item, index))
        return false;
 
    m_items.insert(std::next(m_items.begin(), index), item);
    return true;
}

References canInsertItem(), and m_items.

Referenced by ModelView::JsonItemContainerConverter::JsonItemContainerConverterImpl::create_items(), ModelView::SessionItemTags::insertItem(), and TEST_F().

Here is the call graph for this function:

is_valid_item()

bool SessionItemContainer::is_valid_item ( const SessionItem *  item ) const

private

Returns true if item's modelType is intended for this tag.

Definition at line 152 of file sessionitemcontainer.cpp.

{
    return item && m_tag_info.isValidChild(item->modelType());
}

References ModelView::TagInfo::isValidChild(), m_tag_info, and ModelView::SessionItem::modelType().

Referenced by canInsertItem().

Here is the call graph for this function:

itemAt()

SessionItem * SessionItemContainer::itemAt

(

int

index

)

const

Returns item at given index. Returns nullptr if index is invalid.

Definition at line 109 of file sessionitemcontainer.cpp.

{
    return index >= 0 && index < itemCount() ? m_items[static_cast<size_t>(index)] : nullptr;
}

Referenced by canTakeItem(), ModelView::SessionItemTags::getItem(), takeItem(), TEST_F(), and ModelView::JsonItemContainerConverter::JsonItemContainerConverterImpl::update_items().

itemCount()

int SessionItemContainer::itemCount

(

)

const

Returns number of items in given tag.

Definition at line 39 of file sessionitemcontainer.cpp.

{
    return static_cast<int>(m_items.size());
}

References m_items.

Referenced by canInsertItem(), ModelView::JsonItemContainerConverter::JsonItemContainerConverterImpl::create_items(), ModelView::SessionItemTags::itemCount(), maximum_reached(), minimum_reached(), TEST_F(), and ModelView::JsonItemContainerConverter::JsonItemContainerConverterImpl::update_items().

items()

std::vector< SessionItem * > SessionItemContainer::items

(

)

const

Returns vector of items in this container.

Definition at line 46 of file sessionitemcontainer.cpp.

{
    return m_items;
}

References m_items.

Referenced by ModelView::SessionItemTags::getItems(), and TEST_F().

maximum_reached()

bool SessionItemContainer::maximum_reached ( ) const

private

Returns true if no more items are allowed.

Definition at line 138 of file sessionitemcontainer.cpp.

{
    return m_tag_info.max() != -1 && m_tag_info.max() == itemCount();
}

References itemCount(), m_tag_info, and ModelView::TagInfo::max().

Referenced by canInsertItem().

Here is the call graph for this function:

minimum_reached()

bool SessionItemContainer::minimum_reached ( ) const

private

Returns true if less items than now is not allowed.

Definition at line 145 of file sessionitemcontainer.cpp.

{
    return m_tag_info.min() != -1 && m_tag_info.min() == itemCount();
}

References itemCount(), m_tag_info, and ModelView::TagInfo::min().

Referenced by canTakeItem(), and takeItem().

Here is the call graph for this function:

name()

std::string SessionItemContainer::name

(

)

const

Returns the name of SessionItemTag.

Definition at line 116 of file sessionitemcontainer.cpp.

{
    return m_tag_info.name();
}

References m_tag_info, and ModelView::TagInfo::name().

Referenced by TEST_F().

Here is the call graph for this function:

operator=()

SessionItemContainer& ModelView::SessionItemContainer::operator= ( const SessionItemContainer &  )

delete

tagInfo()

TagInfo SessionItemContainer::tagInfo

(

)

const

Definition at line 121 of file sessionitemcontainer.cpp.

{
    return m_tag_info;
}

References m_tag_info.

Referenced by ModelView::JsonItemContainerConverter::from_json(), and ModelView::JsonItemContainerConverter::to_json().

takeItem()

SessionItem * SessionItemContainer::takeItem

(

int

index

)

Removes item at given index and returns it to the user.

Definition at line 71 of file sessionitemcontainer.cpp.

{
    if (minimum_reached())
        return nullptr;
 
    SessionItem* result = itemAt(index);
    if (result)
        m_items.erase(std::next(m_items.begin(), index));
 
    return result;
}

References itemAt(), m_items, and minimum_reached().

Referenced by ModelView::SessionItemTags::takeItem(), and TEST_F().

Here is the call graph for this function:

Member Data Documentation

m_items

container_t ModelView::SessionItemContainer::m_items

private

Definition at line 69 of file sessionitemcontainer.h.

Referenced by ~SessionItemContainer(), begin(), empty(), end(), indexOfItem(), insertItem(), itemCount(), items(), and takeItem().

m_tag_info

TagInfo ModelView::SessionItemContainer::m_tag_info

private

Definition at line 68 of file sessionitemcontainer.h.

Referenced by is_valid_item(), maximum_reached(), minimum_reached(), name(), and tagInfo().

---

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

• /home/www/ba/mvvm/model/mvvm/model/sessionitemcontainer.h
• /home/www/ba/mvvm/model/mvvm/model/sessionitemcontainer.cpp