RunFitControlWidget Class Reference

Description

The RunFitControlWidget contains elements to start/stop fitting and to provide minimal diagnostic. Part of FitSuiteWidget.

Definition at line 31 of file RunFitControlWidget.h.

Inheritance diagram for RunFitControlWidget:

Collaboration diagram for RunFitControlWidget:

Public Slots
void	onFittingError (const QString &what)

Signals
void	startFittingPushed ()
void	stopFittingPushed ()

Public Member Functions
	RunFitControlWidget (QWidget *parent=nullptr)
	~RunFitControlWidget () override
virtual QList< QAction * >	actionList ()
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
virtual void	setItem (SessionItem *item)

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

Private Slots
void	onFitSuitePropertyChange (const QString &name)
void	onSliderValueChanged (int value)

Private Member Functions
FitSuiteItem *	fitSuiteItem ()
bool	isValidJobItem ()
JobItem *	jobItem ()
int	sliderUpdateInterval ()
int	sliderValueToUpdateInterval (int value)
	converts slider value (1-15) to update interval to be propagated to FitSuiteWidget More...
void	unsubscribeFromChildren ()
void	updateControlElements ()
	Updates button "enabled" status and caution status depending on current job conditions. More...
void	updateIterationsCountLabel ()

Private Attributes
CautionSign *	m_cautionSign
QSlider *	m_intervalSlider
SessionItemController *	m_itemController
QLabel *	m_iterationsCountLabel
QPushButton *	m_startButton
QPushButton *	m_stopButton
QLabel *	m_updateIntervalLabel

Constructor & Destructor Documentation

RunFitControlWidget()

RunFitControlWidget::RunFitControlWidget

(

QWidget *

parent = nullptr

)

Definition at line 36 of file RunFitControlWidget.cpp.

    : SessionItemWidget(parent)
    , m_startButton(new QPushButton)
    , m_stopButton(new QPushButton)
    , m_intervalSlider(new QSlider)
    , m_updateIntervalLabel(new QLabel)
    , m_iterationsCountLabel(new QLabel)
    , m_cautionSign(new CautionSign(this))
{
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
    setFixedHeight(GUI::Constants::RUN_FIT_CONTROL_WIDGET_HEIGHT);
 
    m_startButton->setText("Run");
    m_startButton->setToolTip("Run fitting");
    m_startButton->setMaximumWidth(80);
 
    m_stopButton->setText("Stop");
    m_stopButton->setToolTip("Interrupt fitting");
    m_stopButton->setMaximumWidth(80);
 
    m_intervalSlider->setToolTip(slider_tooltip);
    m_intervalSlider->setOrientation(Qt::Horizontal);
    m_intervalSlider->setRange(0, static_cast<int>(slider_to_interval.size()) - 1);
    m_intervalSlider->setMaximumWidth(120);
    m_intervalSlider->setMinimumWidth(120);
    m_intervalSlider->setFocusPolicy(Qt::NoFocus);
    m_intervalSlider->setValue(5);
 
    QFont font("Monospace", DesignerHelper::getLabelFontSize(), QFont::Normal);
    font.setPointSize(DesignerHelper::getPortFontSize());
    m_updateIntervalLabel->setToolTip(slider_tooltip);
    m_updateIntervalLabel->setFont(font);
    m_updateIntervalLabel->setText(QString::number(sliderUpdateInterval()));
 
    auto* layout = new QHBoxLayout;
    layout->setSpacing(0);
    layout->addWidget(m_startButton);
    layout->addSpacing(5);
    layout->addWidget(m_stopButton);
    layout->addSpacing(5);
    layout->addWidget(m_intervalSlider);
    layout->addSpacing(2);
    layout->addWidget(m_updateIntervalLabel);
    layout->addSpacing(5);
    layout->addStretch();
    layout->addWidget(m_iterationsCountLabel);
    setLayout(layout);
 
    connect(m_startButton, &QPushButton::clicked, [&]() { startFittingPushed(); });
    connect(m_stopButton, &QPushButton::clicked, this, [&]() { stopFittingPushed(); });
    connect(m_intervalSlider, &QSlider::valueChanged, this,
            &RunFitControlWidget::onSliderValueChanged);
 
    setEnabled(false);
}

References DesignerHelper::getLabelFontSize(), DesignerHelper::getPortFontSize(), m_intervalSlider, m_iterationsCountLabel, m_startButton, m_stopButton, m_updateIntervalLabel, onSliderValueChanged(), GUI::Constants::RUN_FIT_CONTROL_WIDGET_HEIGHT, sliderUpdateInterval(), startFittingPushed(), and stopFittingPushed().

Here is the call graph for this function:

~RunFitControlWidget()

RunFitControlWidget::~RunFitControlWidget ( )

override

Definition at line 92 of file RunFitControlWidget.cpp.

{
    unsubscribeFromChildren();
}

References unsubscribeFromChildren().

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().

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(), ParameterTuningWidget::jobItem(), 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:

fitSuiteItem()

FitSuiteItem * RunFitControlWidget::fitSuiteItem ( )

private

Definition at line 173 of file RunFitControlWidget.cpp.

{
    return jobItem() ? jobItem()->fitSuiteItem() : nullptr;
}

References JobItem::fitSuiteItem(), and jobItem().

Referenced by onSliderValueChanged(), subscribeToItem(), unsubscribeFromChildren(), and updateIterationsCountLabel().

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:

isValidJobItem()

bool RunFitControlWidget::isValidJobItem ( )

private

Definition at line 178 of file RunFitControlWidget.cpp.

{
    return jobItem() ? jobItem()->isValidForFitting() : false;
}

References JobItem::isValidForFitting(), and jobItem().

Referenced by updateControlElements().

Here is the call graph for this function:

jobItem()

JobItem * RunFitControlWidget::jobItem ( )

private

Definition at line 168 of file RunFitControlWidget.cpp.

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

References SessionItemWidget::currentItem().

Referenced by fitSuiteItem(), isValidJobItem(), subscribeToItem(), and updateControlElements().

Here is the call graph for this function:

onFitSuitePropertyChange

void RunFitControlWidget::onFitSuitePropertyChange ( const QString &  name )

privateslot

Definition at line 112 of file RunFitControlWidget.cpp.

{
    if (FitSuiteItem::isIterationCountPropertyName(name))
        updateIterationsCountLabel();
}

References FitSuiteItem::isIterationCountPropertyName(), GUI::RealSpace::Particles::name(), and updateIterationsCountLabel().

Referenced by subscribeToItem().

Here is the call graph for this function:

onFittingError

void RunFitControlWidget::onFittingError ( const QString &  what )

slot

Definition at line 97 of file RunFitControlWidget.cpp.

{
    m_cautionSign->clear();
    m_iterationsCountLabel->setText("");
    m_cautionSign->setCautionMessage(what);
}

References CautionSign::clear(), m_cautionSign, m_iterationsCountLabel, and CautionSign::setCautionMessage().

Referenced by FitSessionWidget::onFittingError().

Here is the call graph for this function:

onSliderValueChanged

void RunFitControlWidget::onSliderValueChanged ( int  value )

privateslot

Definition at line 104 of file RunFitControlWidget.cpp.

{
    int interval = sliderValueToUpdateInterval(value);
    m_updateIntervalLabel->setText(QString::number(interval));
    if (fitSuiteItem())
        fitSuiteItem()->setUpdateInterval(interval);
}

References fitSuiteItem(), m_updateIntervalLabel, FitSuiteItem::setUpdateInterval(), and sliderValueToUpdateInterval().

Referenced by RunFitControlWidget().

Here is the call graph for this function:

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:

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:

sliderUpdateInterval()

int RunFitControlWidget::sliderUpdateInterval ( )

private

Definition at line 139 of file RunFitControlWidget.cpp.

{
    return sliderValueToUpdateInterval(m_intervalSlider->value());
}

References m_intervalSlider, and sliderValueToUpdateInterval().

Referenced by RunFitControlWidget(), and subscribeToItem().

Here is the call graph for this function:

sliderValueToUpdateInterval()

int RunFitControlWidget::sliderValueToUpdateInterval ( int  value )

private

converts slider value (1-15) to update interval to be propagated to FitSuiteWidget

Definition at line 146 of file RunFitControlWidget.cpp.

{
    auto svalue = static_cast<size_t>(value);
    return svalue < slider_to_interval.size() ? slider_to_interval[svalue] : default_interval;
}

Referenced by onSliderValueChanged(), and sliderUpdateInterval().

startFittingPushed

void RunFitControlWidget::startFittingPushed ( )

signal

Referenced by RunFitControlWidget(), and FitSessionWidget::setSessionController().

stopFittingPushed

void RunFitControlWidget::stopFittingPushed ( )

signal

Referenced by RunFitControlWidget(), and FitSessionWidget::setSessionController().

subscribeToItem()

void RunFitControlWidget::subscribeToItem ( )

overrideprotectedvirtual

Reimplemented from SessionItemWidget.

Definition at line 118 of file RunFitControlWidget.cpp.

{
    updateControlElements();
 
    fitSuiteItem()->setUpdateInterval(sliderUpdateInterval());
 
    fitSuiteItem()->mapper()->setOnPropertyChange(
        [this](const QString& name) { onFitSuitePropertyChange(name); }, this);
 
    updateIterationsCountLabel();
 
    connect(jobItem(), &JobItem::jobStatusChanged, this,
            [=](const JobStatus) { updateControlElements(); });
}

References fitSuiteItem(), jobItem(), JobItem::jobStatusChanged(), SessionItem::mapper(), GUI::RealSpace::Particles::name(), onFitSuitePropertyChange(), ModelMapper::setOnPropertyChange(), FitSuiteItem::setUpdateInterval(), sliderUpdateInterval(), updateControlElements(), and updateIterationsCountLabel().

Here is the call graph for this function:

unsubscribeFromChildren()

void RunFitControlWidget::unsubscribeFromChildren ( )

private

Definition at line 183 of file RunFitControlWidget.cpp.

{
    if (fitSuiteItem())
        fitSuiteItem()->mapper()->unsubscribe(this);
}

References fitSuiteItem(), SessionItem::mapper(), and ModelMapper::unsubscribe().

Referenced by ~RunFitControlWidget(), and unsubscribeFromItem().

Here is the call graph for this function:

unsubscribeFromItem()

void RunFitControlWidget::unsubscribeFromItem ( )

overrideprotectedvirtual

Reimplemented from SessionItemWidget.

Definition at line 133 of file RunFitControlWidget.cpp.

{
    setEnabled(false);
    unsubscribeFromChildren();
}

References unsubscribeFromChildren().

Here is the call graph for this function:

updateControlElements()

void RunFitControlWidget::updateControlElements ( )

private

Updates button "enabled" status and caution status depending on current job conditions.

Definition at line 154 of file RunFitControlWidget.cpp.

{
    setEnabled(isValidJobItem());
 
    if (jobItem()->getStatus() == JobStatus::Fitting) {
        m_startButton->setEnabled(false);
        m_stopButton->setEnabled(true);
        m_cautionSign->clear();
    } else {
        m_startButton->setEnabled(true);
        m_stopButton->setEnabled(false);
    }
}

References CautionSign::clear(), Fitting, isValidJobItem(), jobItem(), m_cautionSign, m_startButton, and m_stopButton.

Referenced by subscribeToItem().

Here is the call graph for this function:

updateIterationsCountLabel()

void RunFitControlWidget::updateIterationsCountLabel ( )

private

Definition at line 189 of file RunFitControlWidget.cpp.

{
    int niter = fitSuiteItem()->iterationCount();
    m_iterationsCountLabel->setText(QString::number(niter));
}

References fitSuiteItem(), FitSuiteItem::iterationCount(), and m_iterationsCountLabel.

Referenced by onFitSuitePropertyChange(), and subscribeToItem().

Here is the call graph for this function:

Member Data Documentation

m_cautionSign

CautionSign* RunFitControlWidget::m_cautionSign

private

Definition at line 67 of file RunFitControlWidget.h.

Referenced by onFittingError(), and updateControlElements().

m_intervalSlider

QSlider* RunFitControlWidget::m_intervalSlider

private

Definition at line 64 of file RunFitControlWidget.h.

Referenced by RunFitControlWidget(), and sliderUpdateInterval().

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_iterationsCountLabel

QLabel* RunFitControlWidget::m_iterationsCountLabel

private

Definition at line 66 of file RunFitControlWidget.h.

Referenced by RunFitControlWidget(), onFittingError(), and updateIterationsCountLabel().

m_startButton

QPushButton* RunFitControlWidget::m_startButton

private

Definition at line 62 of file RunFitControlWidget.h.

Referenced by RunFitControlWidget(), and updateControlElements().

m_stopButton

QPushButton* RunFitControlWidget::m_stopButton

private

Definition at line 63 of file RunFitControlWidget.h.

Referenced by RunFitControlWidget(), and updateControlElements().

m_updateIntervalLabel

QLabel* RunFitControlWidget::m_updateIntervalLabel

private

Definition at line 65 of file RunFitControlWidget.h.

Referenced by RunFitControlWidget(), and onSliderValueChanged().

---

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

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