LinkInstrumentManager Class Reference

The LinkInstrumentManager class provides communication between InstrumentModel and RealDataModel. More...

Inheritance diagram for LinkInstrumentManager:

Collaboration diagram for LinkInstrumentManager:

Public Member Functions
	LinkInstrumentManager (QObject *parent=nullptr)
bool	canLinkDataToInstrument (const RealDataItem *realDataItem, const QString &identifier, bool quiet=false)
	quiet defines whether a "not possible" message box is shown if link is not possible. More...
QList< RealDataItem * >	linkedRealDataItems (InstrumentItem *instrumentItem)
	Returns list of RealDataItem's linked to given instrument. More...
void	setModels (InstrumentModel *instrumentModel, RealDataModel *realDataModel)
	Sets models and builds initial links. More...

Private Slots
void	onInstrumentAddedOrRemoved ()
	Updates map of instruments on insert/remove InstrumentItem event. More...
void	onInstrumentChildChange (InstrumentItem *instrument, SessionItem *child)
	Perform actions on instrument children change. More...
void	updateInstrumentSubscriptions ()
	Set up callbacks to all instrument items. More...

Private Attributes
InstrumentModel *	m_instrumentModel
RealDataModel *	m_realDataModel

Detailed Description

The LinkInstrumentManager class provides communication between InstrumentModel and RealDataModel.

Particularly, it notifies RealDataItem about changes in linked instruments to adjust axes of IntensityDataItem.

Definition at line 35 of file LinkInstrumentManager.h.

Constructor & Destructor Documentation

LinkInstrumentManager()

LinkInstrumentManager::LinkInstrumentManager ( QObject *  parent = nullptr )

explicit

Definition at line 33 of file LinkInstrumentManager.cpp.

    : QObject(parent), m_instrumentModel(nullptr), m_realDataModel(nullptr)
{
}

Member Function Documentation

canLinkDataToInstrument()

bool LinkInstrumentManager::canLinkDataToInstrument	(	const RealDataItem *	realDataItem,
		const QString &	identifier,
		bool	quiet = false
	)

quiet defines whether a "not possible" message box is shown if link is not possible.

Returns true if RealDataItem can be linked to the instrument (same number of bins).

Use this e.g. for unit tests. The question for adjusting the instrument is not suppressed by this flag.

Also offers dialog to adjust instrument to match shape of real data.

Definition at line 64 of file LinkInstrumentManager.cpp.

{
    auto instrumentItem = m_instrumentModel->findInstrumentById(identifier);
 
    // linking to null instrument is possible, it means unlinking from currently linked
    if (!instrumentItem)
        return true;
 
    const bool isCompatible = ImportDataUtils::Compatible(*instrumentItem, *realDataItem);
    if (!isCompatible) {
        if (!quiet)
            QMessageBox::warning(MainWindow::instance(), "Can't link to instrument",
                                 "Can't link, data is incompatible with the instrument.");
        return false;
    }
 
    if (realDataItem->isSpecularData() && !realDataItem->hasNativeData()) {
        if (!quiet)
            QMessageBox::warning(MainWindow::instance(), "Can't link to instrument",
                                 "Can't link, data is empty.");
        return false;
    }
 
    if (instrumentItem->alignedWith(realDataItem))
        return true;
 
    QString message =
        realDataItem->holdsDimensionalData()
            ? "Experimental data carries information on the range/points of measurement."
            : ImportDataUtils::printShapeMessage(instrumentItem->shape(), realDataItem->shape());
    if (!QuestionOnInstrumentReshaping(message))
        return false;
 
    instrumentItem->updateToRealData(realDataItem);
    return true;
}

References ImportDataUtils::Compatible(), InstrumentModel::findInstrumentById(), RealDataItem::hasNativeData(), RealDataItem::holdsDimensionalData(), MainWindow::instance(), RealDataItem::isSpecularData(), m_instrumentModel, ImportDataUtils::printShapeMessage(), RealDataItem::shape(), and GUIHelpers::warning().

Here is the call graph for this function:

linkedRealDataItems()

QList< RealDataItem * > LinkInstrumentManager::linkedRealDataItems

(

InstrumentItem *

instrumentItem

)

Returns list of RealDataItem's linked to given instrument.

Definition at line 151 of file LinkInstrumentManager.cpp.

{
    ASSERT(instrumentItem != nullptr);
 
    QList<RealDataItem*> result;
    for (auto realDataItem : m_realDataModel->realDataItems()) {
        const QString linkedIdentifier = realDataItem->instrumentId();
        const QString instrumentIdentifier = instrumentItem->id();
 
        if (linkedIdentifier == instrumentIdentifier)
            result.append(realDataItem);
    }
    return result;
}

References ASSERT, InstrumentItem::id(), m_realDataModel, and RealDataModel::realDataItems().

Referenced by onInstrumentChildChange().

Here is the call graph for this function:

onInstrumentAddedOrRemoved

void LinkInstrumentManager::onInstrumentAddedOrRemoved ( )

privateslot

Updates map of instruments on insert/remove InstrumentItem event.

Definition at line 123 of file LinkInstrumentManager.cpp.

{
    // remove links in realDataItems (in case of a linked instrument was removed)
    for (auto realDataItem : m_realDataModel->realDataItems()) {
        if (!m_instrumentModel->instrumentExists(realDataItem->instrumentId()))
            realDataItem->clearInstrumentId();
    }
 
    updateInstrumentSubscriptions();
}

References InstrumentModel::instrumentExists(), m_instrumentModel, m_realDataModel, RealDataModel::realDataItems(), and updateInstrumentSubscriptions().

Referenced by setModels().

Here is the call graph for this function:

onInstrumentChildChange

void LinkInstrumentManager::onInstrumentChildChange ( InstrumentItem *  instrument, SessionItem *  child  )

privateslot

Perform actions on instrument children change.

Definition at line 105 of file LinkInstrumentManager.cpp.

{
    if (child == nullptr)
        return;
 
    ASSERT(instrument != nullptr);
 
    // Run through all RealDataItem and refresh linking to match possible change in detector
    // axes definition.
    for (auto realDataItem : linkedRealDataItems(instrument))
        if (!instrument->alignedWith(realDataItem))
            realDataItem->clearInstrumentId();
        else
            realDataItem->updateToInstrument(instrument);
}

References InstrumentItem::alignedWith(), ASSERT, and linkedRealDataItems().

Referenced by updateInstrumentSubscriptions().

Here is the call graph for this function:

setModels()

void LinkInstrumentManager::setModels	(	InstrumentModel *	instrumentModel,
		RealDataModel *	realDataModel
	)

Sets models and builds initial links.

Definition at line 40 of file LinkInstrumentManager.cpp.

{
    ASSERT(instrumentModel != nullptr);
    ASSERT(realDataModel != nullptr);
 
    if (m_instrumentModel)
        m_instrumentModel->disconnect(this);
 
    if (m_realDataModel)
        m_realDataModel->disconnect(this);
 
    m_instrumentModel = instrumentModel;
    m_realDataModel = realDataModel;
 
    connect(m_instrumentModel, &InstrumentModel::instrumentAddedOrRemoved, this,
            &LinkInstrumentManager::onInstrumentAddedOrRemoved);
 
    updateInstrumentSubscriptions();
}

References ASSERT, InstrumentModel::instrumentAddedOrRemoved(), m_instrumentModel, m_realDataModel, onInstrumentAddedOrRemoved(), and updateInstrumentSubscriptions().

Referenced by MainWindow::MainWindow().

Here is the call graph for this function:

updateInstrumentSubscriptions

void LinkInstrumentManager::updateInstrumentSubscriptions ( )

privateslot

Set up callbacks to all instrument items.

Definition at line 136 of file LinkInstrumentManager.cpp.

{
    for (auto instrumentItem : m_instrumentModel->instrumentItems()) {
        instrumentItem->mapper()->unsubscribe(this);
 
        instrumentItem->mapper()->setOnAnyChildChange(
            [this, instrumentItem](SessionItem* child) {
                onInstrumentChildChange(instrumentItem, child);
            },
            this);
    }
}

References InstrumentModel::instrumentItems(), m_instrumentModel, and onInstrumentChildChange().

Referenced by onInstrumentAddedOrRemoved(), and setModels().

Here is the call graph for this function:

Member Data Documentation

m_instrumentModel

InstrumentModel* LinkInstrumentManager::m_instrumentModel

private

Definition at line 58 of file LinkInstrumentManager.h.

Referenced by canLinkDataToInstrument(), onInstrumentAddedOrRemoved(), setModels(), and updateInstrumentSubscriptions().

m_realDataModel

RealDataModel* LinkInstrumentManager::m_realDataModel

private

Definition at line 59 of file LinkInstrumentManager.h.

Referenced by linkedRealDataItems(), onInstrumentAddedOrRemoved(), and setModels().

---

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

• /home/www/ba/GUI/coregui/Views/ImportDataWidgets/LinkInstrumentManager.h
• /home/www/ba/GUI/coregui/Views/ImportDataWidgets/LinkInstrumentManager.cpp