InstrumentsEditController Class Reference

Description

Class to modify the instruments list or a single instrument and provide the necessary signaling within BornAgain.

An instance of this class is held in the project document (ProjectDocument). Whenever you want to modify instruments of the current project, use this instance to ensure proper signaling of changes. If you change an instrument without using any method in this class, you have to notify this class about the modification by calling notifyInstrumentChanged.

If you want to be notified about any changes of instruments in the current project, listen to the signals of this instance.

For uses other than the instruments in the current project (like e.g. for the instruments library), you can create a dedicated instance and handle the instrument collection in question with this separate instance.

Definition at line 40 of file InstrumentsEditController.h.

Inheritance diagram for InstrumentsEditController:

Collaboration diagram for InstrumentsEditController:

Signals
void	instrumentAddedOrRemoved ()
	Signals a change in the list of instruments. More...
void	instrumentChanged (const InstrumentItem *instrument)
	Signals any change in the settings of the given instrument. More...
void	instrumentNameChanged (const InstrumentItem *instrument)
	Signals name change of the given instrument. More...

Public Member Functions
	InstrumentsEditController (InstrumentCollection *instruments)
InstrumentItem *	addCopy (const InstrumentItem *instrument, const QString &name)
	Copy an instrument, set its name and emit the respective signal. More...
template<typename T >
T *	addInstrument ()
	Add an instrument and emit the respective signal. More...
InstrumentCollection *	collectedItems ()
	The list of existing instruments. More...
void	notifyInstrumentChanged (InstrumentItem *instrument)
	Simply emits the instrumentChanged signal. Call this whenever you change an instrument's data without using this edit controller. By calling this method, the listeners will be notified about the changes. More...
void	removeInstrument (InstrumentItem *instrument)
	Add an instrument and emit the respective signal. More...
void	setInstrumentName (InstrumentItem *instrument, const QString &name)
	Set an instrument's name and emit the respective signal. More...
void	updateInstrumentToRealDataItem (InstrumentItem *instrument, const RealDataItem *realDataItem)
	Calls the instrument's updateToRealData and emits the respective signal. More...

Private Attributes
InstrumentCollection *	m_instruments
	The edited/controlled instruments. This pointer is borrowed, not owned. More...

Constructor & Destructor Documentation

InstrumentsEditController()

InstrumentsEditController::InstrumentsEditController

(

InstrumentCollection *

instruments

)

Definition at line 18 of file InstrumentsEditController.cpp.

    : m_instruments(instruments)
{
}

Member Function Documentation

addCopy()

InstrumentItem * InstrumentsEditController::addCopy	(	const InstrumentItem *	instrument,
		const QString &	name
	)

Copy an instrument, set its name and emit the respective signal.

Definition at line 34 of file InstrumentsEditController.cpp.

{
    InstrumentItem* copy = m_instruments->insertCopy(*instrument);
    copy->setInstrumentName(name);
    emit instrumentAddedOrRemoved();
    return copy;
}

References InstrumentCollection::insertCopy(), instrumentAddedOrRemoved(), m_instruments, GUI::RealSpace::Particles::name(), and InstrumentItem::setInstrumentName().

Referenced by InstrumentLibrary::add(), and InstrumentListModel::copyInstrument().

Here is the call graph for this function:

addInstrument()

template<typename T >

T * InstrumentsEditController::addInstrument

Add an instrument and emit the respective signal.

Definition at line 91 of file InstrumentsEditController.h.

{
    auto* t = m_instruments->addInstrument<T>();
    emit instrumentAddedOrRemoved();
    return t;
}

References InstrumentCollection::addInstrument(), instrumentAddedOrRemoved(), and m_instruments.

Referenced by InstrumentListModel::addNewInstrument().

Here is the call graph for this function:

collectedItems()

InstrumentCollection * InstrumentsEditController::collectedItems

(

)

The list of existing instruments.

Definition at line 23 of file InstrumentsEditController.cpp.

{
    return m_instruments;
}

References m_instruments.

Referenced by InstrumentListModel::addNewInstrument(), InstrumentListModel::copyInstrument(), InstrumentListModel::data(), InstrumentListModel::instrumentForIndex(), InstrumentListModel::onInstrumentNameChanged(), and InstrumentListModel::rowCount().

instrumentAddedOrRemoved

void InstrumentsEditController::instrumentAddedOrRemoved ( )

signal

Signals a change in the list of instruments.

Referenced by InstrumentLibrary::InstrumentLibrary(), LinkInstrumentManager::LinkInstrumentManager(), ProjectDocument::ProjectDocument(), RealDataPropertiesWidget::RealDataPropertiesWidget(), addCopy(), addInstrument(), and removeInstrument().

instrumentChanged

void InstrumentsEditController::instrumentChanged ( const InstrumentItem *  instrument )

signal

Signals any change in the settings of the given instrument.

Signals also a name change, which has its own additional signal

Referenced by InstrumentLibrary::InstrumentLibrary(), LinkInstrumentManager::LinkInstrumentManager(), ProjectDocument::ProjectDocument(), InstrumentView::hideEvent(), InstrumentEditController::notifyInclinationAxisChanged(), InstrumentEditController::notifyInstrumentChanged(), notifyInstrumentChanged(), InstrumentEditController::notifyWavelengthDistributionChanged(), InstrumentEditController::setDouble(), setInstrumentName(), InstrumentView::showEvent(), and updateInstrumentToRealDataItem().

instrumentNameChanged

void InstrumentsEditController::instrumentNameChanged ( const InstrumentItem *  instrument )

signal

Signals name change of the given instrument.

In addition to this, instrumentChanged() will be emitted as well.

Referenced by InstrumentListModel::InstrumentListModel(), RealDataPropertiesWidget::RealDataPropertiesWidget(), and setInstrumentName().

notifyInstrumentChanged()

void InstrumentsEditController::notifyInstrumentChanged

(

InstrumentItem *

instrument

)

Simply emits the instrumentChanged signal. Call this whenever you change an instrument's data without using this edit controller. By calling this method, the listeners will be notified about the changes.

Definition at line 59 of file InstrumentsEditController.cpp.

{
    emit instrumentChanged(instrument);
}

References instrumentChanged().

Referenced by InstrumentLibraryEditor::onInstrumentChangedByEditor(), and InstrumentView::onInstrumentChangedByEditor().

removeInstrument()

void InstrumentsEditController::removeInstrument

(

InstrumentItem *

instrument

)

Add an instrument and emit the respective signal.

Definition at line 28 of file InstrumentsEditController.cpp.

{
    m_instruments->removeInstrument(instrument);
    emit instrumentAddedOrRemoved();
}

References instrumentAddedOrRemoved(), m_instruments, and InstrumentCollection::removeInstrument().

Referenced by InstrumentListModel::removeInstrument().

Here is the call graph for this function:

setInstrumentName()

void InstrumentsEditController::setInstrumentName	(	InstrumentItem *	instrument,
		const QString &	name
	)

Set an instrument's name and emit the respective signal.

Definition at line 43 of file InstrumentsEditController.cpp.

{
    if (instrument->instrumentName() != name) {
        instrument->setInstrumentName(name);
        emit instrumentNameChanged(instrument);
        emit instrumentChanged(instrument);
    }
}

References instrumentChanged(), InstrumentItem::instrumentName(), instrumentNameChanged(), GUI::RealSpace::Particles::name(), and InstrumentItem::setInstrumentName().

Referenced by InstrumentListModel::addNewInstrument(), InstrumentView::onInstrumentNameEdited(), and InstrumentEditController::setInstrumentName().

Here is the call graph for this function:

updateInstrumentToRealDataItem()

void InstrumentsEditController::updateInstrumentToRealDataItem	(	InstrumentItem *	instrument,
		const RealDataItem *	realDataItem
	)

Calls the instrument's updateToRealData and emits the respective signal.

Definition at line 52 of file InstrumentsEditController.cpp.

{
    instrument->updateToRealData(realDataItem);
    emit instrumentChanged(instrument);
}

References instrumentChanged(), and InstrumentItem::updateToRealData().

Referenced by LinkInstrumentManager::canLinkDataToInstrument().

Here is the call graph for this function:

Member Data Documentation

m_instruments

InstrumentCollection* InstrumentsEditController::m_instruments

private

The edited/controlled instruments. This pointer is borrowed, not owned.

Definition at line 86 of file InstrumentsEditController.h.

Referenced by addCopy(), addInstrument(), collectedItems(), and removeInstrument().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/InstrumentsEditController.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/InstrumentsEditController.cpp