LinkInstrumentManager Class Reference

Description

The LinkInstrumentManager class provides communication between InstrumentCollection and RealDataModel. Particularly, it notifies RealDataItem about changes in linked instruments to adjust axes of IntensityDataItem.

Definition at line 31 of file LinkInstrumentManager.h.

Inheritance diagram for LinkInstrumentManager:

Collaboration diagram for LinkInstrumentManager:

Signals
void	linkToInstrumentChanged (const RealDataItem *realDataItem)

Public Member Functions
	LinkInstrumentManager (ProjectDocument *document)
bool	canLinkDataToInstrument (const RealDataItem *realDataItem, const QString &identifier, QWidget *parent)
	Returns true if RealDataItem can be linked to the instrument (same number of bins). Also offers dialog to adjust instrument to match shape of real data. quiet defines whether a "not possible" message box is shown if link is not possible. Use this e.g. for unit tests. The question for adjusting the instrument is not suppressed by this flag. More...

Private Member Functions
void	onInstrumentAddedOrRemoved ()
void	onInstrumentChanged (const InstrumentItem *instrument)

Private Attributes
ProjectDocument *	m_document

Constructor & Destructor Documentation

LinkInstrumentManager()

LinkInstrumentManager::LinkInstrumentManager

(

ProjectDocument *

document

)

Definition at line 68 of file LinkInstrumentManager.cpp.

    : m_document(document)
{
    connect(m_document->instrumentsEditController(),
            &InstrumentsEditController::instrumentAddedOrRemoved, this,
            &LinkInstrumentManager::onInstrumentAddedOrRemoved);
 
    connect(m_document->instrumentsEditController(), &InstrumentsEditController::instrumentChanged,
            this, &LinkInstrumentManager::onInstrumentChanged);
}

References InstrumentsEditController::instrumentAddedOrRemoved(), InstrumentsEditController::instrumentChanged(), ProjectDocument::instrumentsEditController(), m_document, onInstrumentAddedOrRemoved(), and onInstrumentChanged().

Here is the call graph for this function:

Member Function Documentation

canLinkDataToInstrument()

bool LinkInstrumentManager::canLinkDataToInstrument	(	const RealDataItem *	realDataItem,
		const QString &	identifier,
		QWidget *	parent
	)

Returns true if RealDataItem can be linked to the instrument (same number of bins). Also offers dialog to adjust instrument to match shape of real data. quiet defines whether a "not possible" message box is shown if link is not possible. Use this e.g. for unit tests. The question for adjusting the instrument is not suppressed by this flag.

Definition at line 79 of file LinkInstrumentManager.cpp.

{
    auto* instrumentItem = m_document->collectedItems()->findInstrumentById(identifier);
 
    // linking to null instrument is possible, it means unlinking from currently linked
    if (!instrumentItem)
        return true;
 
    if (instrumentItem->shape().size() != realDataItem->shape().size()) {
        if (parent)
            QMessageBox::warning(parent, "Can't link to instrument",
                                 "Can't link, data is incompatible with the instrument.");
        return false;
    }
 
    if (realDataItem->isSpecularData() && !realDataItem->hasNativeData()) {
        if (parent)
            QMessageBox::warning(parent, "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."
            : printShapeMessage(instrumentItem->shape(), realDataItem->shape());
    if (!QuestionOnInstrumentReshaping(message))
        return false;
 
    m_document->instrumentsEditController()->updateInstrumentToRealDataItem(instrumentItem,
                                                                            realDataItem);
    return true;
}

References ProjectDocument::collectedItems(), InstrumentCollection::findInstrumentById(), RealDataItem::hasNativeData(), RealDataItem::holdsDimensionalData(), ProjectDocument::instrumentsEditController(), RealDataItem::isSpecularData(), m_document, RealDataItem::shape(), InstrumentsEditController::updateInstrumentToRealDataItem(), and GUI::View::Helpers::warning().

Referenced by RealDataPropertiesWidget::onInstrumentComboIndexChanged().

Here is the call graph for this function:

linkToInstrumentChanged

void LinkInstrumentManager::linkToInstrumentChanged ( const RealDataItem *  realDataItem )

signal

Referenced by RealDataPropertiesWidget::RealDataPropertiesWidget(), and onInstrumentChanged().

onInstrumentAddedOrRemoved()

void LinkInstrumentManager::onInstrumentAddedOrRemoved ( )

private

Definition at line 130 of file LinkInstrumentManager.cpp.

{
    // remove links in realDataItems (in case of a linked instrument was removed)
    for (auto* realDataItem : m_document->realDataModel()->realDataItems())
        if (!m_document->collectedItems()->instrumentExists(realDataItem->instrumentId()))
            realDataItem->unlinkFromInstrument();
}

References ProjectDocument::collectedItems(), InstrumentCollection::instrumentExists(), m_document, RealDataModel::realDataItems(), and ProjectDocument::realDataModel().

Referenced by LinkInstrumentManager().

Here is the call graph for this function:

onInstrumentChanged()

void LinkInstrumentManager::onInstrumentChanged ( const InstrumentItem *  instrument )

private

Definition at line 116 of file LinkInstrumentManager.cpp.

{
    // Run through all RealDataItem and refresh linking to match possible change in detector
    // axes definition.
    for (auto* realDataItem : m_document->realDataModel()->realDataItems())
        if (realDataItem->instrumentId() == instrument->id()) {
            if (!instrument->alignedWith(realDataItem)) {
                realDataItem->unlinkFromInstrument();
                emit linkToInstrumentChanged(realDataItem);
            } else
                realDataItem->linkToInstrument(instrument); // link stays same, only data is updated
        }
}

References InstrumentItem::alignedWith(), InstrumentItem::id(), linkToInstrumentChanged(), m_document, RealDataModel::realDataItems(), and ProjectDocument::realDataModel().

Referenced by LinkInstrumentManager().

Here is the call graph for this function:

Member Data Documentation

m_document

ProjectDocument* LinkInstrumentManager::m_document

private

Definition at line 53 of file LinkInstrumentManager.h.

Referenced by LinkInstrumentManager(), canLinkDataToInstrument(), onInstrumentAddedOrRemoved(), and onInstrumentChanged().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Project/LinkInstrumentManager.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Project/LinkInstrumentManager.cpp