ModelMapper Class Reference

Description

Definition at line 24 of file ModelMapper.h.

Inheritance diagram for ModelMapper:

Collaboration diagram for ModelMapper:

Public Slots
void	onBeginRemoveRows (const QModelIndex &parent, int first, int last)
void	onDataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles={})
void	onRowRemoved (const QModelIndex &parent, int first, int last)
void	onRowsInserted (const QModelIndex &parent, int first, int last)

Public Member Functions
	ModelMapper (QObject *parent=nullptr)
void	callOnItemDestroy ()
	Notifies subscribers if an item owning given mapper is about to be destroyed. More...
void	setActive (bool state)
void	setItem (SessionItem *item)
void	setOnAboutToRemoveChild (std::function< void(SessionItem *)> f, const void *caller=nullptr)
void	setOnChildPropertyChange (std::function< void(SessionItem *, QString)> f, const void *caller=nullptr)
	Calls back on child property change, report childItem and property name. More...
void	setOnChildrenChange (std::function< void(SessionItem *)> f, const void *caller=nullptr)
	Calls back when number of children has changed, reports newChild. newChild == nullptr denotes the case when number of children has decreased. More...
void	setOnItemDestroy (std::function< void(SessionItem *)> f, const void *caller=nullptr)
void	setOnPropertyChange (std::function< void(QString)> f, const void *caller=nullptr)
void	setOnPropertyChange (std::function< void(SessionItem *, QString)> f, const void *caller=nullptr)
void	setOnValueChange (std::function< void(void)> f, const void *caller=nullptr)
void	unsubscribe (const void *caller)
	Cancels all subscriptions of given caller. More...

Private Types
using	call_item_str_t = std::pair< std::function< void(SessionItem *, QString)>, const void * >
using	call_item_t = std::pair< std::function< void(SessionItem *)>, const void * >
using	call_str_t = std::pair< std::function< void(QString)>, const void * >
using	call_t = std::pair< std::function< void(void)>, const void * >

Private Member Functions
void	callOnAboutToRemoveChild (SessionItem *item)
void	callOnChildPropertyChange (SessionItem *item, const QString &name)
void	callOnChildrenChange (SessionItem *item)
void	callOnPropertyChange (const QString &name)
void	callOnValueChange ()
template<class U >
void	clean_container (U &v, const void *caller)
	removes all callbacks related to given caller More...
void	clearMapper ()
int	nestlingDepth (SessionItem *item, int level=0)
void	setModel (SessionModel *model)

Private Attributes
QModelIndex	m_aboutToDelete
bool	m_active
SessionItem *	m_item
SessionModel *	m_model
std::vector< call_item_t >	m_onAboutToRemoveChild
std::vector< call_item_str_t >	m_onChildPropertyChange
std::vector< call_item_t >	m_onChildrenChange
std::vector< call_item_t >	m_onItemDestroy
std::vector< call_item_str_t >	m_onPropertyChange
std::vector< call_t >	m_onValueChange

Member Typedef Documentation

call_item_str_t

using ModelMapper::call_item_str_t = std::pair<std::function<void(SessionItem*, QString)>, const void*>

private

Definition at line 86 of file ModelMapper.h.

call_item_t

using ModelMapper::call_item_t = std::pair<std::function<void(SessionItem*)>, const void*>

private

Definition at line 85 of file ModelMapper.h.

call_str_t

using ModelMapper::call_str_t = std::pair<std::function<void(QString)>, const void*>

private

Definition at line 84 of file ModelMapper.h.

call_t

using ModelMapper::call_t = std::pair<std::function<void(void)>, const void*>

private

Definition at line 83 of file ModelMapper.h.

Constructor & Destructor Documentation

ModelMapper()

ModelMapper::ModelMapper

(

QObject *

parent = nullptr

)

Definition at line 18 of file ModelMapper.cpp.

    : QObject(parent)
    , m_active(true)
    , m_model(nullptr)
    , m_item(nullptr)
{
}

Member Function Documentation

callOnAboutToRemoveChild()

void ModelMapper::callOnAboutToRemoveChild ( SessionItem *  item )

private

Definition at line 145 of file ModelMapper.cpp.

{
    if (m_active)
        for (const auto& f : m_onAboutToRemoveChild)
            f.first(item);
}

References m_active, and m_onAboutToRemoveChild.

Referenced by onBeginRemoveRows().

callOnChildPropertyChange()

void ModelMapper::callOnChildPropertyChange ( SessionItem *  item, const QString &  name  )

private

Definition at line 131 of file ModelMapper.cpp.

{
    if (m_active)
        for (const auto& f : m_onChildPropertyChange)
            f.first(item, name);
}

References m_active, m_onChildPropertyChange, and GUI::RealSpace::Particles::name().

Referenced by onDataChanged().

Here is the call graph for this function:

callOnChildrenChange()

void ModelMapper::callOnChildrenChange ( SessionItem *  item )

private

Definition at line 138 of file ModelMapper.cpp.

{
    if (m_active)
        for (const auto& f : m_onChildrenChange)
            f.first(item);
}

References m_active, and m_onChildrenChange.

Referenced by onRowRemoved(), and onRowsInserted().

callOnItemDestroy()

void ModelMapper::callOnItemDestroy

(

)

Notifies subscribers if an item owning given mapper is about to be destroyed.

Definition at line 153 of file ModelMapper.cpp.

{
    if (m_active)
        for (const auto& f : m_onItemDestroy)
            f.first(m_item);
}

References m_active, m_item, and m_onItemDestroy.

callOnPropertyChange()

void ModelMapper::callOnPropertyChange ( const QString &  name )

private

Definition at line 124 of file ModelMapper.cpp.

{
    if (m_active)
        for (const auto& f : m_onPropertyChange)
            f.first(m_item, name);
}

References m_active, m_item, m_onPropertyChange, and GUI::RealSpace::Particles::name().

Referenced by onDataChanged().

Here is the call graph for this function:

callOnValueChange()

void ModelMapper::callOnValueChange ( )

private

Definition at line 117 of file ModelMapper.cpp.

{
    if (m_active && !m_onValueChange.empty())
        for (const auto& f : m_onValueChange)
            f.first();
}

References m_active, and m_onValueChange.

Referenced by onDataChanged().

clean_container()

template<class U >

void ModelMapper::clean_container ( U &  v, const void *  caller  )

inlineprivate

removes all callbacks related to given caller

Definition at line 98 of file ModelMapper.h.

{
    v.erase(std::remove_if(
                v.begin(), v.end(),
                [caller](typename U::value_type const& x) -> bool { return (x.second == caller); }),
            v.end());
}

Referenced by unsubscribe().

clearMapper()

void ModelMapper::clearMapper ( )

private

Definition at line 160 of file ModelMapper.cpp.

{
    m_item = nullptr;
    setModel(nullptr);
    m_onValueChange.clear();
    m_onPropertyChange.clear();
    m_onChildPropertyChange.clear();
    m_onChildrenChange.clear();
    m_onItemDestroy.clear();
    m_onAboutToRemoveChild.clear();
}

References m_item, m_onAboutToRemoveChild, m_onChildPropertyChange, m_onChildrenChange, m_onItemDestroy, m_onPropertyChange, m_onValueChange, and setModel().

Referenced by onRowRemoved().

Here is the call graph for this function:

nestlingDepth()

int ModelMapper::nestlingDepth ( SessionItem *  item, int  level = 0  )

private

Definition at line 107 of file ModelMapper.cpp.

{
    if (item == nullptr || item == m_model->rootItem())
        return -1;
    if (item == m_item)
        return level;
 
    return nestlingDepth(item->parentItem(), level + 1);
}

References m_item, m_model, SessionItem::parentItem(), and SessionModel::rootItem().

Referenced by onBeginRemoveRows(), onDataChanged(), onRowRemoved(), and onRowsInserted().

Here is the call graph for this function:

onBeginRemoveRows

void ModelMapper::onBeginRemoveRows ( const QModelIndex &  parent, int  first, int  last  )

slot

Definition at line 210 of file ModelMapper.cpp.

{
    SessionItem* oldChild = m_model->itemForIndex(m_model->index(first, 0, parent));
 
    int nestling = nestlingDepth(m_model->itemForIndex(parent));
 
    if (oldChild && nestling == 0)
        callOnAboutToRemoveChild(oldChild);
 
    if (m_item == oldChild)
        m_aboutToDelete = m_model->index(first, 0, parent);
}

References callOnAboutToRemoveChild(), SessionModel::index(), SessionModel::itemForIndex(), m_aboutToDelete, m_item, m_model, and nestlingDepth().

Referenced by setModel().

Here is the call graph for this function:

onDataChanged

void ModelMapper::onDataChanged ( const QModelIndex &  topLeft, const QModelIndex &  bottomRight, const QVector< int > &  roles = {}  )

slot

Definition at line 172 of file ModelMapper.cpp.

{
    if (topLeft.parent() != bottomRight.parent())
        return; // range must be from the same parent
 
    SessionItem* item = m_model->itemForIndex(topLeft);
 
    int nestling = nestlingDepth(item);
    if (nestling == 0)
        callOnValueChange();
 
    if (nestling == 1) {
        // something happened with our children
        if (SessionItem* item = m_model->itemForIndex(topLeft)) {
            // only care f
            const QString tag = m_item->tagFromItem(item);
            if (!tag.isEmpty())
                callOnPropertyChange(tag);
        }
    }
    if (nestling > 1) {
        if (SessionItem* parent = item->parentItem()) {
            const QString tag = parent->tagFromItem(item);
            if (!tag.isEmpty())
                callOnChildPropertyChange(parent, tag);
        }
    }
}

References callOnChildPropertyChange(), callOnPropertyChange(), callOnValueChange(), SessionModel::itemForIndex(), m_item, m_model, nestlingDepth(), SessionItem::parentItem(), and SessionItem::tagFromItem().

Referenced by setModel().

Here is the call graph for this function:

onRowRemoved

void ModelMapper::onRowRemoved ( const QModelIndex &  parent, int  first, int  last  )

slot

Definition at line 223 of file ModelMapper.cpp.

{
    if (nestlingDepth(m_model->itemForIndex(parent)) == 0)
        callOnChildrenChange(nullptr);
 
    if (m_aboutToDelete.isValid() && m_aboutToDelete == m_model->index(first, 0, parent))
        clearMapper();
}

References callOnChildrenChange(), clearMapper(), SessionModel::index(), SessionModel::itemForIndex(), m_aboutToDelete, m_model, and nestlingDepth().

Referenced by setModel().

Here is the call graph for this function:

onRowsInserted

void ModelMapper::onRowsInserted ( const QModelIndex &  parent, int  first, int  last  )

slot

Definition at line 202 of file ModelMapper.cpp.

{
    SessionItem* newChild = m_model->itemForIndex(m_model->index(first, 0, parent));
 
    if (nestlingDepth(newChild) == 1)
        callOnChildrenChange(newChild);
}

References callOnChildrenChange(), SessionModel::index(), SessionModel::itemForIndex(), m_model, and nestlingDepth().

Referenced by setModel().

Here is the call graph for this function:

setActive()

void ModelMapper::setActive ( bool  state )

inline

Definition at line 43 of file ModelMapper.h.

{ m_active = state; }

References m_active.

setItem()

void ModelMapper::setItem

(

SessionItem *

item

)

Definition at line 26 of file ModelMapper.cpp.

{
    if (item) {
        m_item = item;
        setModel(item->model());
    }
}

References m_item, SessionItem::model(), and setModel().

Here is the call graph for this function:

setModel()

void ModelMapper::setModel ( SessionModel *  model )

private

Definition at line 88 of file ModelMapper.cpp.

{
    if (m_model) {
        disconnect(m_model, &SessionModel::dataChanged, this, &ModelMapper::onDataChanged);
        disconnect(m_model, &SessionModel::rowsInserted, this, &ModelMapper::onRowsInserted);
        disconnect(m_model, &SessionModel::rowsAboutToBeRemoved, this,
                   &ModelMapper::onBeginRemoveRows);
        disconnect(m_model, &SessionModel::rowsRemoved, this, &ModelMapper::onRowRemoved);
    }
    m_model = model;
    if (m_model) {
        connect(m_model, &SessionModel::dataChanged, this, &ModelMapper::onDataChanged);
        connect(m_model, &SessionModel::rowsInserted, this, &ModelMapper::onRowsInserted);
        connect(m_model, &SessionModel::rowsAboutToBeRemoved, this,
                &ModelMapper::onBeginRemoveRows);
        connect(m_model, &SessionModel::rowsRemoved, this, &ModelMapper::onRowRemoved);
    }
}

References m_model, onBeginRemoveRows(), onDataChanged(), onRowRemoved(), and onRowsInserted().

Referenced by clearMapper(), and setItem().

Here is the call graph for this function:

setOnAboutToRemoveChild()

void ModelMapper::setOnAboutToRemoveChild	(	std::function< void(SessionItem *)>	f,
		const void *	caller = nullptr
	)

Definition at line 72 of file ModelMapper.cpp.

{
    m_onAboutToRemoveChild.emplace_back(f, caller);
}

References m_onAboutToRemoveChild.

Referenced by ProjectionsPlot::subscribeToItem().

setOnChildPropertyChange()

void ModelMapper::setOnChildPropertyChange	(	std::function< void(SessionItem *, QString)>	f,
		const void *	caller = nullptr
	)

Calls back on child property change, report childItem and property name.

Definition at line 53 of file ModelMapper.cpp.

{
    m_onChildPropertyChange.emplace_back(f, caller);
}

References m_onChildPropertyChange.

Referenced by PropertyRepeater::addItem(), SpecularDataPropertyWidget::setCurrentItem(), IntensityDataPropertyWidget::setItem(), Plot1D::subscribeToItem(), SpecularPlot::subscribeToItem(), ColorMap::subscribeToItem(), and ProjectionsPlot::subscribeToItem().

setOnChildrenChange()

void ModelMapper::setOnChildrenChange	(	std::function< void(SessionItem *)>	f,
		const void *	caller = nullptr
	)

Calls back when number of children has changed, reports newChild. newChild == nullptr denotes the case when number of children has decreased.

Definition at line 62 of file ModelMapper.cpp.

{
    m_onChildrenChange.emplace_back(f, caller);
}

References m_onChildrenChange.

Referenced by ProjectionsPlot::subscribeToItem().

setOnItemDestroy()

void ModelMapper::setOnItemDestroy	(	std::function< void(SessionItem *)>	f,
		const void *	caller = nullptr
	)

Definition at line 67 of file ModelMapper.cpp.

{
    m_onItemDestroy.emplace_back(f, caller);
}

References m_onItemDestroy.

Referenced by FitParameterModel::FitParameterModel(), IShape2DView::IShape2DView(), PropertyRepeater::addItem(), IntensityDataPropertyWidget::setItem(), and SessionItemController::setItem().

setOnPropertyChange() [1/2]

void ModelMapper::setOnPropertyChange	(	std::function< void(QString)>	f,
		const void *	caller = nullptr
	)

Definition at line 39 of file ModelMapper.cpp.

{
    auto ff = [=](SessionItem* /*item*/, const QString& property) { f(property); };
    m_onPropertyChange.emplace_back(ff, caller);
}

References m_onPropertyChange.

Referenced by Data1DViewItem::Data1DViewItem(), FitParameterItem::FitParameterItem(), IShape2DView::IShape2DView(), PropertyRepeater::addItem(), MaskEditorPropertyPanel::addMaskCheckBox(), MaskEditorPropertyPanel::addMaskSpinBox(), SpecularDataPropertyWidget::setCurrentItem(), IntensityDataPropertyWidget::setItem(), FitSessionController::setItem(), RunFitControlWidget::subscribeToItem(), IntensityDataCanvas::subscribeToItem(), FitFlowWidget::subscribeToItem(), Plot1D::subscribeToItem(), SpecularPlot::subscribeToItem(), ColorMap::subscribeToItem(), and ProjectionsPlot::subscribeToItem().

setOnPropertyChange() [2/2]

void ModelMapper::setOnPropertyChange	(	std::function< void(SessionItem *, QString)>	f,
		const void *	caller = nullptr
	)

Definition at line 45 of file ModelMapper.cpp.

{
    m_onPropertyChange.emplace_back(f, caller);
}

References m_onPropertyChange.

setOnValueChange()

void ModelMapper::setOnValueChange	(	std::function< void(void)>	f,
		const void *	caller = nullptr
	)

Definition at line 34 of file ModelMapper.cpp.

{
    m_onValueChange.emplace_back(f, caller);
}

References m_onValueChange.

Referenced by GroupItem::GroupItem(), SpecularPlot::subscribeToItem(), ColorMap::subscribeToItem(), and ProjectionsPlot::subscribeToItem().

unsubscribe()

void ModelMapper::unsubscribe

(

const void *

caller

)

Cancels all subscriptions of given caller.

Definition at line 78 of file ModelMapper.cpp.

{
    clean_container(m_onValueChange, caller);
    clean_container(m_onPropertyChange, caller);
    clean_container(m_onChildPropertyChange, caller);
    clean_container(m_onChildrenChange, caller);
    clean_container(m_onItemDestroy, caller);
    clean_container(m_onAboutToRemoveChild, caller);
}

References clean_container(), m_onAboutToRemoveChild, m_onChildPropertyChange, m_onChildrenChange, m_onItemDestroy, m_onPropertyChange, and m_onValueChange.

Referenced by FitParameterModel::~FitParameterModel(), IntensityDataPropertyWidget::~IntensityDataPropertyWidget(), IShape2DView::disconnectFromItem(), SessionItemController::onControllerDestroy(), SpecularDataPropertyWidget::setCurrentItem(), MaskEditorPropertyPanel::setCurrentMaskItem(), IntensityDataPropertyWidget::setItem(), SessionItemController::setItem(), SessionItemController::unsubscribe(), RunFitControlWidget::unsubscribeFromChildren(), and ProjectionsPlot::unsubscribeFromChildren().

Here is the call graph for this function:

Member Data Documentation

m_aboutToDelete

QModelIndex ModelMapper::m_aboutToDelete

private

Definition at line 94 of file ModelMapper.h.

Referenced by onBeginRemoveRows(), and onRowRemoved().

m_active

bool ModelMapper::m_active

private

Definition at line 79 of file ModelMapper.h.

Referenced by callOnAboutToRemoveChild(), callOnChildPropertyChange(), callOnChildrenChange(), callOnItemDestroy(), callOnPropertyChange(), callOnValueChange(), and setActive().

m_item

SessionItem* ModelMapper::m_item

private

Definition at line 81 of file ModelMapper.h.

Referenced by callOnItemDestroy(), callOnPropertyChange(), clearMapper(), nestlingDepth(), onBeginRemoveRows(), onDataChanged(), and setItem().

m_model

SessionModel* ModelMapper::m_model

private

Definition at line 80 of file ModelMapper.h.

Referenced by nestlingDepth(), onBeginRemoveRows(), onDataChanged(), onRowRemoved(), onRowsInserted(), and setModel().

m_onAboutToRemoveChild

std::vector<call_item_t> ModelMapper::m_onAboutToRemoveChild

private

Definition at line 93 of file ModelMapper.h.

Referenced by callOnAboutToRemoveChild(), clearMapper(), setOnAboutToRemoveChild(), and unsubscribe().

m_onChildPropertyChange

std::vector<call_item_str_t> ModelMapper::m_onChildPropertyChange

private

Definition at line 90 of file ModelMapper.h.

Referenced by callOnChildPropertyChange(), clearMapper(), setOnChildPropertyChange(), and unsubscribe().

m_onChildrenChange

std::vector<call_item_t> ModelMapper::m_onChildrenChange

private

Definition at line 91 of file ModelMapper.h.

Referenced by callOnChildrenChange(), clearMapper(), setOnChildrenChange(), and unsubscribe().

m_onItemDestroy

std::vector<call_item_t> ModelMapper::m_onItemDestroy

private

Definition at line 92 of file ModelMapper.h.

Referenced by callOnItemDestroy(), clearMapper(), setOnItemDestroy(), and unsubscribe().

m_onPropertyChange

std::vector<call_item_str_t> ModelMapper::m_onPropertyChange

private

Definition at line 89 of file ModelMapper.h.

Referenced by callOnPropertyChange(), clearMapper(), setOnPropertyChange(), and unsubscribe().

m_onValueChange

std::vector<call_t> ModelMapper::m_onValueChange

private

Definition at line 88 of file ModelMapper.h.

Referenced by callOnValueChange(), clearMapper(), setOnValueChange(), and unsubscribe().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/BaseItem/ModelMapper.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/BaseItem/ModelMapper.cpp