InstrumentEditController Class Reference

Description

Single-instrument-adapter to InstrumentsEditorController.

InstrumentsEditorController is not instrument-wise, but handles all instruments. This is sometimes unhandy, e.g. if the changed instrument has to be passed through many hierarchies to only be able to notify correctly. Instantiate this class instead and pass it to editors.

Calling notification methods or change methods also take care of dependent data, like in notifyWavelengthDistributionChanged().

Definition at line 33 of file InstrumentEditController.h.

Inheritance diagram for InstrumentEditController:

Collaboration diagram for InstrumentEditController:

Public Member Functions
	InstrumentEditController (InstrumentsEditController *ec, InstrumentItem *instrument)
void	notifyInclinationAxisChanged ()
	Update dependent data and emit a changed signal. More...
void	notifyInstrumentChanged ()
	Call this if any instrument value has been changed outside this controller. More...
void	notifyWavelengthDistributionChanged ()
	Update dependent data and emit a changed signal. More...
void	setDouble (DoubleDescriptor &d, double newValue)
	Sets the double and emits InstrumentsEditController::instrumentChanged if the double changed. More...
void	setInstrumentName (const QString &name)
	Set the instrument name and emit the respective signal. More...

Private Attributes
InstrumentsEditController *	m_ec
InstrumentItem *	m_instrumentItem

Constructor & Destructor Documentation

InstrumentEditController()

InstrumentEditController::InstrumentEditController	(	InstrumentsEditController *	ec,
		InstrumentItem *	instrument
	)

Definition at line 21 of file InstrumentEditController.cpp.

    : m_instrumentItem(instrument)
    , m_ec(ec)
{
}

Member Function Documentation

notifyInclinationAxisChanged()

void InstrumentEditController::notifyInclinationAxisChanged

(

)

Update dependent data and emit a changed signal.

Definition at line 58 of file InstrumentEditController.cpp.

{
    // update wavelength. This is necessary after a change in the inclination axis type
    if (auto* specularBeam = dynamic_cast<SpecularBeamItem*>(m_instrumentItem->beamItem()))
        specularBeam->updateWavelength();
    m_ec->instrumentChanged(m_instrumentItem);
}

References InstrumentItem::beamItem(), InstrumentsEditController::instrumentChanged(), m_ec, and m_instrumentItem.

Referenced by SpecularBeamEditor::SpecularBeamEditor().

Here is the call graph for this function:

notifyInstrumentChanged()

void InstrumentEditController::notifyInstrumentChanged

(

)

Call this if any instrument value has been changed outside this controller.

emits InstrumentsEditController::instrumentChanged For example if a double has been changed, but setDouble() has not been called

Definition at line 41 of file InstrumentEditController.cpp.

{
    m_ec->instrumentChanged(m_instrumentItem);
}

References InstrumentsEditController::instrumentChanged(), m_ec, and m_instrumentItem.

notifyWavelengthDistributionChanged()

void InstrumentEditController::notifyWavelengthDistributionChanged

(

)

Update dependent data and emit a changed signal.

Definition at line 46 of file InstrumentEditController.cpp.

{
    // update values in pointwise axis. This is necessary after a change of the mean value of the
    // wavelength.
    if (auto* specularBeam = dynamic_cast<SpecularBeamItem*>(m_instrumentItem->beamItem())) {
        if (auto* pw = dynamic_cast<PointwiseAxisItem*>(specularBeam->inclinationAxis()))
            pw->updateIndicators();
    }
 
    m_ec->instrumentChanged(m_instrumentItem);
}

References InstrumentItem::beamItem(), InstrumentsEditController::instrumentChanged(), m_ec, and m_instrumentItem.

Referenced by SpecularBeamEditor::SpecularBeamEditor().

Here is the call graph for this function:

setDouble()

void InstrumentEditController::setDouble	(	DoubleDescriptor &	d,
		double	newValue
	)

Sets the double and emits InstrumentsEditController::instrumentChanged if the double changed.

Definition at line 33 of file InstrumentEditController.cpp.

{
    if (d.get() != newValue) {
        d.set(newValue);
        m_ec->instrumentChanged(m_instrumentItem);
    }
}

References DoubleDescriptor::get, InstrumentsEditController::instrumentChanged(), m_ec, m_instrumentItem, and DoubleDescriptor::set.

setInstrumentName()

void InstrumentEditController::setInstrumentName

(

const QString &

name

)

Set the instrument name and emit the respective signal.

The signal is emitted by the parent InstrumentsEditController.

Definition at line 28 of file InstrumentEditController.cpp.

{
    m_ec->setInstrumentName(m_instrumentItem, name);
}

References m_ec, m_instrumentItem, GUI::RealSpace::Particles::name(), and InstrumentsEditController::setInstrumentName().

Here is the call graph for this function:

Member Data Documentation

m_ec

InstrumentsEditController* InstrumentEditController::m_ec

private

Definition at line 61 of file InstrumentEditController.h.

Referenced by notifyInclinationAxisChanged(), notifyInstrumentChanged(), notifyWavelengthDistributionChanged(), setDouble(), and setInstrumentName().

m_instrumentItem

InstrumentItem* InstrumentEditController::m_instrumentItem

private

Definition at line 60 of file InstrumentEditController.h.

Referenced by notifyInclinationAxisChanged(), notifyInstrumentChanged(), notifyWavelengthDistributionChanged(), setDouble(), and setInstrumentName().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Instrument/InstrumentEditController.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Instrument/InstrumentEditController.cpp