ParameterTuningWidget Class Reference

Description

Main widget for real time parameter tuning. Contains a tree for parameter tuning and the model to provide drag-and-drop in FitActivityPanel.

Definition at line 34 of file ParameterTuningWidget.h.

Inheritance diagram for ParameterTuningWidget:

Collaboration diagram for ParameterTuningWidget:

Public Slots
void	makeSelected (ParameterItem *item)
void	onCurrentLinkChanged (ParameterItem *item)
void	onLockZValueChanged (bool value)
void	onSliderValueChanged (double value)
void	restoreModelsOfCurrentJobItem ()

Signals
void	itemContextMenuRequest (const QPoint &point)

Public Member Functions
	ParameterTuningWidget (QWidget *parent=nullptr)
virtual QList< QAction * >	actionList ()
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
QVector< ParameterItem * >	getSelectedParameters ()
	Returns list of ParameterItem's currently selected in parameter tree. More...
QItemSelectionModel *	selectionModel ()
virtual void	setItem (SessionItem *item)

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *) override
void	hideEvent (QHideEvent *) override
void	showEvent (QShowEvent *) override
void	subscribeToItem () override
virtual void	unsubscribeFromItem ()

Private Slots
void	onCustomContextMenuRequested (const QPoint &point)
void	updateParameterModel ()

Private Member Functions
void	closeActiveEditors ()
JobItem *	jobItem ()
void	setTuningDelegateEnabled (bool enabled)
	Sets delegate to enabled/disabled state. In 'disabled' state the delegate is in ReadOnlyMode, if it was containing already some editing widget, it will be forced to close. More...
void	updateDragAndDropSettings ()
	Disable drag-and-drop abilities, if job is in fit running state. More...
void	updateJobStatus ()

Private Attributes
CautionSign *	m_cautionSign
ParameterTuningDelegate *	m_delegate
SessionItemController *	m_itemController
JobModel *	m_jobModel
ParameterTuningModel *	m_parameterTuningModel
SliderSettingsWidget *	m_sliderSettingsWidget
QTreeView *	m_treeView

Constructor & Destructor Documentation

ParameterTuningWidget()

ParameterTuningWidget::ParameterTuningWidget ( QWidget *  parent = nullptr )

explicit

Definition at line 30 of file ParameterTuningWidget.cpp.

    : SessionItemWidget(parent)
    , m_jobModel(nullptr)
    , m_parameterTuningModel(nullptr)
    , m_sliderSettingsWidget(new SliderSettingsWidget(this))
    , m_treeView(new QTreeView)
    , m_delegate(new ParameterTuningDelegate(this))
    , m_cautionSign(new CautionSign(m_treeView))
{
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 
    m_treeView->setItemDelegate(m_delegate);
    m_treeView->setContextMenuPolicy(Qt::CustomContextMenu);
    m_treeView->setDragDropMode(QAbstractItemView::NoDragDrop);
    m_treeView->setAttribute(Qt::WA_MacShowFocusRect, false);
 
    auto* resetValuesAction = new QAction(QIcon(":/images/undo-variant.svg"), "Reset values", this);
    resetValuesAction->setToolTip("Reset parameter tree to initial values");
    connect(resetValuesAction, &QAction::triggered, this,
            &ParameterTuningWidget::restoreModelsOfCurrentJobItem);
 
    auto* toolbar = new StyledToolbar(this);
    toolbar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    toolbar->addAction(resetValuesAction);
 
    auto* mainLayout = new QVBoxLayout;
    mainLayout->setMargin(0);
    mainLayout->setSpacing(0);
    mainLayout->addWidget(toolbar);
    mainLayout->addWidget(m_sliderSettingsWidget);
    mainLayout->addWidget(m_treeView);
    setLayout(mainLayout);
 
    connect(m_sliderSettingsWidget, &SliderSettingsWidget::sliderRangeFactorChanged, this,
            &ParameterTuningWidget::onSliderValueChanged);
    connect(m_sliderSettingsWidget, &SliderSettingsWidget::lockzChanged, this,
            &ParameterTuningWidget::onLockZValueChanged);
    connect(m_delegate, &ParameterTuningDelegate::currentLinkChanged, this,
            &ParameterTuningWidget::onCurrentLinkChanged);
    connect(m_treeView, &QTreeView::customContextMenuRequested, this,
            &ParameterTuningWidget::onCustomContextMenuRequested);
}

References ParameterTuningDelegate::currentLinkChanged(), SliderSettingsWidget::lockzChanged(), m_delegate, m_sliderSettingsWidget, m_treeView, onCurrentLinkChanged(), onCustomContextMenuRequested(), onLockZValueChanged(), onSliderValueChanged(), restoreModelsOfCurrentJobItem(), and SliderSettingsWidget::sliderRangeFactorChanged().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SessionItemWidget::actionList ( )

virtualinherited

Reimplemented in IntensityDataProjectionsWidget, SpecularDataWidget, SpecularDataCanvas, FitComparisonWidget1D, FitComparisonWidget, IntensityDataWidget, IntensityDataCanvas, SpecularDataImportWidget, RealDataPresenter, and RealDataMaskWidget.

Definition at line 36 of file SessionItemWidget.cpp.

{
    return QList<QAction*>();
}

Referenced by ItemComboWidget::setPresentation().

closeActiveEditors()

void ParameterTuningWidget::closeActiveEditors ( )

private

Definition at line 215 of file ParameterTuningWidget.cpp.

{
    QModelIndex index = m_treeView->currentIndex();
    QWidget* editor = m_treeView->indexWidget(index);
    if (editor) {
        // m_delegate->commitData(editor);
        m_delegate->closeEditor(editor, QAbstractItemDelegate::NoHint);
    }
    m_treeView->selectionModel()->clearSelection();
}

References m_delegate, and m_treeView.

Referenced by restoreModelsOfCurrentJobItem(), and setTuningDelegateEnabled().

contextMenuEvent()

void ParameterTuningWidget::contextMenuEvent ( QContextMenuEvent *  )

overrideprotected

Definition at line 164 of file ParameterTuningWidget.cpp.

{
    // reimplemented to suppress context menu from QMainWindow
}

currentItem() [1/2]

SessionItem * SessionItemWidget::currentItem ( )

inherited

Definition at line 41 of file SessionItemWidget.cpp.

{
    return const_cast<SessionItem*>(static_cast<const SessionItemWidget*>(this)->currentItem());
}

Referenced by FitFlowWidget::fitSuiteItem(), RealDataMaskWidget::intensityDataItem(), IntensityDataCanvas::intensityDataItem(), IntensityDataWidget::intensityDataItem(), IntensityDataProjectionsWidget::intensityDataItem(), ProjectionsPlot::intensityItem(), ColorMap::intensityItem(), JobResultsPresenter::itemPresentation(), FitParameterWidget::jobItem(), jobItem(), RunFitControlWidget::jobItem(), FitComparisonWidget::jobItem(), FitComparisonWidget1D::jobItem(), IntensityDataPropertyWidget::jobItem(), SpecularDataPropertyWidget::jobItem(), SpecularDataImportWidget::realDataItem(), ItemComboWidget::setPresentation(), JobResultsPresenter::setPresentation(), SpecularDataImportWidget::specularDataItem(), SpecularDataCanvas::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), ItemComboWidget::subscribeToItem(), ProjectionsPlot::unsubscribeFromChildren(), and Plot1D::viewItem().

currentItem() [2/2]

const SessionItem * SessionItemWidget::currentItem ( ) const

inherited

Definition at line 46 of file SessionItemWidget.cpp.

{
    return m_itemController->currentItem();
}

References SessionItemController::currentItem(), and SessionItemWidget::m_itemController.

Here is the call graph for this function:

getSelectedParameters()

QVector< ParameterItem * > ParameterTuningWidget::getSelectedParameters

(

)

Returns list of ParameterItem's currently selected in parameter tree.

Definition at line 81 of file ParameterTuningWidget.cpp.

{
    QVector<ParameterItem*> result;
    for (auto index : selectionModel()->selectedIndexes())
        if (ParameterItem* parItem = m_parameterTuningModel->getParameterItem(index))
            result.push_back(parItem);
 
    return result;
}

References ParameterTuningModel::getParameterItem(), m_parameterTuningModel, and selectionModel().

Referenced by FitParameterWidget::canCreateFitParameter(), FitParameterWidget::canRemoveFromFitParameters(), FitParameterWidget::onAddToFitParAction(), FitParameterWidget::onCreateFitParAction(), and FitParameterWidget::onRemoveFromFitParAction().

Here is the call graph for this function:

hideEvent()

void SessionItemWidget::hideEvent ( QHideEvent *  )

overrideprotectedinherited

Definition at line 56 of file SessionItemWidget.cpp.

{
    m_itemController->unsubscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::unsubscribe().

Here is the call graph for this function:

itemContextMenuRequest

void ParameterTuningWidget::itemContextMenuRequest ( const QPoint &  point )

signal

Referenced by onCustomContextMenuRequested(), and FitParameterWidget::setParameterTuningWidget().

jobItem()

JobItem * ParameterTuningWidget::jobItem ( )

private

Definition at line 182 of file ParameterTuningWidget.cpp.

{
    return dynamic_cast<JobItem*>(currentItem());
}

References SessionItemWidget::currentItem().

Referenced by onCurrentLinkChanged(), onLockZValueChanged(), restoreModelsOfCurrentJobItem(), subscribeToItem(), updateDragAndDropSettings(), updateJobStatus(), and updateParameterModel().

Here is the call graph for this function:

makeSelected

void ParameterTuningWidget::makeSelected ( ParameterItem *  item )

slot

Definition at line 157 of file ParameterTuningWidget.cpp.

{
    QModelIndex index = m_parameterTuningModel->indexForItem(item);
    if (index.isValid())
        selectionModel()->select(index, QItemSelectionModel::Select);
}

References ParameterTuningModel::indexForItem(), m_parameterTuningModel, and selectionModel().

Referenced by FitParameterWidget::onFitParametersSelectionChanged().

Here is the call graph for this function:

onCurrentLinkChanged

void ParameterTuningWidget::onCurrentLinkChanged ( ParameterItem *  item )

slot

Definition at line 91 of file ParameterTuningWidget.cpp.

{
    ASSERT(jobItem());
 
    if (jobItem()->isRunning())
        return;
 
    if (item) {
        // link.updateItem(); // FIXME circular dependency if uncomment
        m_jobModel->runJob(jobItem());
    }
}

References jobItem(), m_jobModel, and JobModel::runJob().

Referenced by ParameterTuningWidget().

Here is the call graph for this function:

onCustomContextMenuRequested

void ParameterTuningWidget::onCustomContextMenuRequested ( const QPoint &  point )

privateslot

Definition at line 138 of file ParameterTuningWidget.cpp.

{
    emit itemContextMenuRequest(m_treeView->mapToGlobal(point + QPoint(2, 22)));
}

References itemContextMenuRequest(), and m_treeView.

Referenced by ParameterTuningWidget().

onLockZValueChanged

void ParameterTuningWidget::onLockZValueChanged ( bool  value )

slot

Definition at line 109 of file ParameterTuningWidget.cpp.

{
    if (!jobItem())
        return;
    if (IntensityDataItem* intensityDataItem = jobItem()->intensityDataItem())
        intensityDataItem->setZAxisLocked(value);
}

References GUI::Model::DataItemUtils::intensityDataItem(), jobItem(), and IntensityDataItem::setZAxisLocked().

Referenced by ParameterTuningWidget().

Here is the call graph for this function:

onSliderValueChanged

void ParameterTuningWidget::onSliderValueChanged ( double  value )

slot

Definition at line 104 of file ParameterTuningWidget.cpp.

{
    m_delegate->setSliderRangeFactor(value);
}

References m_delegate, and ParameterTuningDelegate::setSliderRangeFactor().

Referenced by ParameterTuningWidget().

Here is the call graph for this function:

restoreModelsOfCurrentJobItem

void ParameterTuningWidget::restoreModelsOfCurrentJobItem ( )

slot

Definition at line 143 of file ParameterTuningWidget.cpp.

{
    ASSERT(m_jobModel);
    ASSERT(jobItem());
 
    if (jobItem()->isRunning())
        return;
 
    closeActiveEditors();
 
    m_jobModel->restore(jobItem());
    m_jobModel->runJob(jobItem());
}

References closeActiveEditors(), jobItem(), m_jobModel, JobModel::restore(), and JobModel::runJob().

Referenced by ParameterTuningWidget().

Here is the call graph for this function:

selectionModel()

QItemSelectionModel * ParameterTuningWidget::selectionModel

(

)

Definition at line 73 of file ParameterTuningWidget.cpp.

{
    ASSERT(m_treeView);
    return m_treeView->selectionModel();
}

References m_treeView.

Referenced by getSelectedParameters(), makeSelected(), and FitParameterWidget::onFitParametersSelectionChanged().

setItem()

void SessionItemWidget::setItem ( SessionItem *  item )

virtualinherited

Reimplemented in SpecularPlotCanvas, SpecularDataImportWidget, SpecularDataWidget, IntensityDataWidget, JobResultsPresenter, ItemComboWidget, ProjectionsWidget, SpecularDataCanvas, IntensityDataCanvas, ColorMapCanvas, and Plot1DCanvas.

Definition at line 28 of file SessionItemWidget.cpp.

{
    m_itemController->setItem(item);
 
    if (isVisible())
        m_itemController->subscribe();
}

References SessionItemWidget::m_itemController, SessionItemController::setItem(), and SessionItemController::subscribe().

Referenced by MaskGraphicsProxy::setIntensityItem(), FitSessionWidget::setItem(), Plot1DCanvas::setItem(), ColorMapCanvas::setItem(), IntensityDataCanvas::setItem(), SpecularDataCanvas::setItem(), ProjectionsWidget::setItem(), ItemComboWidget::setItem(), IntensityDataWidget::setItem(), SpecularDataWidget::setItem(), SpecularDataImportWidget::setItem(), SpecularPlotCanvas::setItem(), ItemComboWidget::setPresentation(), FitComparisonWidget::subscribeToItem(), and FitComparisonWidget1D::subscribeToItem().

Here is the call graph for this function:

setTuningDelegateEnabled()

void ParameterTuningWidget::setTuningDelegateEnabled ( bool  enabled )

private

Sets delegate to enabled/disabled state. In 'disabled' state the delegate is in ReadOnlyMode, if it was containing already some editing widget, it will be forced to close.

Definition at line 205 of file ParameterTuningWidget.cpp.

{
    if (enabled)
        m_delegate->setReadOnly(false);
    else {
        m_delegate->setReadOnly(true);
        closeActiveEditors();
    }
}

References closeActiveEditors(), m_delegate, and ParameterTuningDelegate::setReadOnly().

Referenced by updateDragAndDropSettings().

Here is the call graph for this function:

showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )

overrideprotectedinherited

Definition at line 51 of file SessionItemWidget.cpp.

{
    m_itemController->subscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::subscribe().

Here is the call graph for this function:

subscribeToItem()

void ParameterTuningWidget::subscribeToItem ( )

overrideprotectedvirtual

Reimplemented from SessionItemWidget.

Definition at line 169 of file ParameterTuningWidget.cpp.

{
    m_jobModel = dynamic_cast<JobModel*>(jobItem()->model());
 
    updateParameterModel();
    updateDragAndDropSettings();
 
    connect(jobItem(), &JobItem::jobStatusChanged, this,
            [=](const JobStatus) { updateJobStatus(); });
 
    updateJobStatus();
}

References jobItem(), JobItem::jobStatusChanged(), m_jobModel, SessionItem::model(), updateDragAndDropSettings(), updateJobStatus(), and updateParameterModel().

Here is the call graph for this function:

unsubscribeFromItem()

virtual void SessionItemWidget::unsubscribeFromItem ( )

inlineprotectedvirtualinherited

Reimplemented in ProjectionsPlot, IntensityDataProjectionsWidget, ColorMap, SpecularPlot, Plot1D, FitFlowWidget, FitComparisonWidget1D, FitComparisonWidget, RealDataMaskWidget, and RunFitControlWidget.

Definition at line 44 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

updateDragAndDropSettings()

void ParameterTuningWidget::updateDragAndDropSettings ( )

private

Disable drag-and-drop abilities, if job is in fit running state.

Definition at line 189 of file ParameterTuningWidget.cpp.

{
    ASSERT(jobItem());
    if (jobItem()->getStatus() == JobStatus::Fitting) {
        setTuningDelegateEnabled(false);
        m_treeView->setDragDropMode(QAbstractItemView::NoDragDrop);
    } else {
        setTuningDelegateEnabled(true);
        if (jobItem()->isValidForFitting())
            m_treeView->setDragDropMode(QAbstractItemView::DragOnly);
    }
}

References Fitting, jobItem(), m_treeView, and setTuningDelegateEnabled().

Referenced by subscribeToItem(), and updateJobStatus().

Here is the call graph for this function:

updateJobStatus()

void ParameterTuningWidget::updateJobStatus ( )

private

Definition at line 226 of file ParameterTuningWidget.cpp.

{
    m_cautionSign->clear();
 
    if (jobItem()->isFailed()) {
        QString message;
        message.append("Current parameter values cause simulation failure.\n\n");
        message.append(jobItem()->getComments());
        m_cautionSign->setCautionMessage(message);
    }
 
    updateDragAndDropSettings();
}

References CautionSign::clear(), jobItem(), m_cautionSign, CautionSign::setCautionMessage(), and updateDragAndDropSettings().

Referenced by subscribeToItem().

Here is the call graph for this function:

updateParameterModel

void ParameterTuningWidget::updateParameterModel ( )

privateslot

Definition at line 117 of file ParameterTuningWidget.cpp.

{
    ASSERT(m_jobModel);
 
    if (!jobItem())
        return;
 
    if (!jobItem()->sampleItem() || !jobItem()->instrumentItem())
        throw Error("ModelTuningWidget::updateParameterModel() -> Error."
                    "JobItem doesn't have sample or instrument model.");
 
    delete m_parameterTuningModel;
    m_parameterTuningModel =
        new ParameterTuningModel(jobItem()->parameterContainerItem()->parameterTreeRoot(), this);
 
    m_treeView->setModel(m_parameterTuningModel);
    if (m_treeView->columnWidth(0) < 170)
        m_treeView->setColumnWidth(0, 170);
    m_treeView->expandAll();
}

References Error, jobItem(), m_jobModel, m_parameterTuningModel, and m_treeView.

Referenced by subscribeToItem().

Here is the call graph for this function:

Member Data Documentation

m_cautionSign

CautionSign* ParameterTuningWidget::m_cautionSign

private

Definition at line 74 of file ParameterTuningWidget.h.

Referenced by updateJobStatus().

m_delegate

ParameterTuningDelegate* ParameterTuningWidget::m_delegate

private

Definition at line 73 of file ParameterTuningWidget.h.

Referenced by ParameterTuningWidget(), closeActiveEditors(), onSliderValueChanged(), and setTuningDelegateEnabled().

m_itemController

SessionItemController* SessionItemWidget::m_itemController

privateinherited

Definition at line 49 of file SessionItemWidget.h.

Referenced by SessionItemWidget::SessionItemWidget(), SessionItemWidget::currentItem(), SessionItemWidget::hideEvent(), SessionItemWidget::setItem(), and SessionItemWidget::showEvent().

m_jobModel

JobModel* ParameterTuningWidget::m_jobModel

private

Definition at line 69 of file ParameterTuningWidget.h.

Referenced by onCurrentLinkChanged(), restoreModelsOfCurrentJobItem(), subscribeToItem(), and updateParameterModel().

m_parameterTuningModel

ParameterTuningModel* ParameterTuningWidget::m_parameterTuningModel

private

Definition at line 70 of file ParameterTuningWidget.h.

Referenced by getSelectedParameters(), makeSelected(), and updateParameterModel().

m_sliderSettingsWidget

SliderSettingsWidget* ParameterTuningWidget::m_sliderSettingsWidget

private

Definition at line 71 of file ParameterTuningWidget.h.

Referenced by ParameterTuningWidget().

m_treeView

QTreeView* ParameterTuningWidget::m_treeView

private

Definition at line 72 of file ParameterTuningWidget.h.

Referenced by ParameterTuningWidget(), closeActiveEditors(), onCustomContextMenuRequested(), selectionModel(), updateDragAndDropSettings(), and updateParameterModel().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Fit/ParameterTuningWidget.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Fit/ParameterTuningWidget.cpp