FitSessionController Class Reference

Description

Controls all activity related to the single fitting task for JobItem. Provides interaction between FitSessionWidget and fit observers.

Definition at line 31 of file FitSessionController.h.

Inheritance diagram for FitSessionController:

Collaboration diagram for FitSessionController:

Public Slots
void	onStartFittingRequest ()
void	onStopFittingRequest ()

Signals
void	fittingError (const QString &message)
void	fittingFinished ()
void	fittingStarted ()

Public Member Functions
	FitSessionController (QObject *parent=nullptr)
	~FitSessionController () override
FitLog *	fitLog ()
void	setItem (JobItem *item)

Private Slots
void	onFittingError (const QString &text)
void	onFittingFinished ()
void	onFittingStarted ()
void	onObserverUpdate ()
void	updateFitParameterValues (const FitProgressInfo &info)
void	updateIterationCount (const FitProgressInfo &info)
void	updateLog (const FitProgressInfo &info)

Private Attributes
bool	m_block_progress_update
std::unique_ptr< FitLog >	m_fitlog
JobItem *	m_jobItem
std::shared_ptr< FitObjectiveBuilder >	m_objectiveBuilder
std::shared_ptr< GUIFitObserver >	m_observer
FitWorkerLauncher *	m_runFitManager

Constructor & Destructor Documentation

FitSessionController()

FitSessionController::FitSessionController

(

QObject *

parent = nullptr

)

Definition at line 33 of file FitSessionController.cpp.

    : QObject(parent)
    , m_jobItem(nullptr)
    , m_runFitManager(new FitWorkerLauncher(this))
    , m_observer(new GUIFitObserver)
    , m_fitlog(new FitLog(this))
    , m_block_progress_update(false)
{
    connect(m_observer.get(), &GUIFitObserver::updateReady, this,
            &FitSessionController::onObserverUpdate);
 
    connect(m_runFitManager, &FitWorkerLauncher::fittingStarted, this,
            &FitSessionController::onFittingStarted);
    connect(m_runFitManager, &FitWorkerLauncher::fittingFinished, this,
            &FitSessionController::onFittingFinished);
    connect(m_runFitManager, &FitWorkerLauncher::fittingError, this,
            &FitSessionController::onFittingError);
}

References FitWorkerLauncher::fittingError(), FitWorkerLauncher::fittingFinished(), FitWorkerLauncher::fittingStarted(), m_observer, m_runFitManager, onFittingError(), onFittingFinished(), onFittingStarted(), onObserverUpdate(), and GUIFitObserver::updateReady().

Here is the call graph for this function:

~FitSessionController()

FitSessionController::~FitSessionController ( )

overridedefault

Member Function Documentation

fitLog()

FitLog * FitSessionController::fitLog

(

)

Definition at line 92 of file FitSessionController.cpp.

{
    return m_fitlog.get();
}

References m_fitlog.

Referenced by FitActivityPanel::setItem().

fittingError

void FitSessionController::fittingError ( const QString &  message )

signal

Referenced by onFittingError(), onStartFittingRequest(), and FitSessionWidget::setSessionController().

fittingFinished

void FitSessionController::fittingFinished ( )

signal

Referenced by onFittingFinished().

fittingStarted

void FitSessionController::fittingStarted ( )

signal

Referenced by onFittingStarted().

onFittingError

void FitSessionController::onFittingError ( const QString &  text )

privateslot

Definition at line 145 of file FitSessionController.cpp.

{
    QString message;
    message.append("Current settings cause fitting failure.\n\n");
    message.append(text);
    m_fitlog->append(message.toStdString(), FitLogLevel::Error);
    m_jobItem->setEndTime(m_runFitManager->fitEnd());
 
    emit fittingError(message);
}

References Error, FitWorkerLauncher::fitEnd(), fittingError(), m_fitlog, m_jobItem, m_runFitManager, and JobItem::setEndTime().

Referenced by FitSessionController().

Here is the call graph for this function:

onFittingFinished

void FitSessionController::onFittingFinished ( )

privateslot

Definition at line 132 of file FitSessionController.cpp.

{
    if (m_jobItem->getStatus() != JobStatus::Failed)
        m_jobItem->setStatus(JobStatus::Completed);
    m_jobItem->setEndTime(m_runFitManager->fitEnd());
    m_jobItem->setProgress(100);
 
    if (m_jobItem->isCompleted())
        m_fitlog->append("Done", FitLogLevel::Success);
 
    emit fittingFinished();
}

References Completed, Failed, FitWorkerLauncher::fitEnd(), fittingFinished(), JobItem::getStatus(), JobItem::isCompleted(), m_fitlog, m_jobItem, m_runFitManager, JobItem::setEndTime(), JobItem::setProgress(), JobItem::setStatus(), and Success.

Referenced by FitSessionController().

Here is the call graph for this function:

onFittingStarted

void FitSessionController::onFittingStarted ( )

privateslot

Definition at line 120 of file FitSessionController.cpp.

{
    m_fitlog->clearLog();
 
    m_jobItem->setStatus(JobStatus::Fitting);
    m_jobItem->setProgress(0);
    m_jobItem->setBeginTime(m_runFitManager->fitStart());
    m_jobItem->setEndTime(QDateTime());
 
    emit fittingStarted();
}

References FitWorkerLauncher::fitStart(), Fitting, fittingStarted(), m_fitlog, m_jobItem, m_runFitManager, JobItem::setBeginTime(), JobItem::setEndTime(), JobItem::setProgress(), and JobItem::setStatus().

Referenced by FitSessionController().

Here is the call graph for this function:

onObserverUpdate

void FitSessionController::onObserverUpdate ( )

privateslot

Definition at line 102 of file FitSessionController.cpp.

{
    auto progressInfo = m_observer->progressInfo();
    m_jobItem->dataItem()->setRawDataVector(progressInfo.simValues());
 
    updateIterationCount(progressInfo);
 
    if (!use_fit_objective)
        updateFitParameterValues(progressInfo);
 
    updateLog(progressInfo);
 
    if (!progressInfo.logInfo().empty())
        m_fitlog->append(progressInfo.logInfo(), FitLogLevel::Default);
 
    m_observer->finishedPlotting();
}

References JobItem::dataItem(), Default, m_fitlog, m_jobItem, m_observer, DataItem::setRawDataVector(), updateFitParameterValues(), updateIterationCount(), and updateLog().

Referenced by FitSessionController().

Here is the call graph for this function:

onStartFittingRequest

void FitSessionController::onStartFittingRequest ( )

slot

Definition at line 74 of file FitSessionController.cpp.

{
    if (!m_jobItem)
        return;
 
    try {
        m_objectiveBuilder = std::make_unique<FitObjectiveBuilder>(m_jobItem);
        m_observer->setInterval(m_jobItem->fitSuiteItem()->updateInterval());
        m_objectiveBuilder->attachObserver(m_observer);
        m_observer->finishedPlotting();
        m_runFitManager->runFitting(m_objectiveBuilder);
    } catch (std::exception& e) {
        m_jobItem->setStatus(JobStatus::Failed);
        m_fitlog->append(e.what(), FitLogLevel::Error);
        emit fittingError(QString::fromStdString(e.what()));
    }
}

References Error, Failed, JobItem::fitSuiteItem(), fittingError(), m_fitlog, m_jobItem, m_objectiveBuilder, m_observer, m_runFitManager, FitWorkerLauncher::runFitting(), JobItem::setStatus(), and FitSuiteItem::updateInterval().

Referenced by FitSessionWidget::setSessionController().

Here is the call graph for this function:

onStopFittingRequest

void FitSessionController::onStopFittingRequest ( )

slot

Definition at line 97 of file FitSessionController.cpp.

{
    m_runFitManager->interruptFitting();
}

References FitWorkerLauncher::interruptFitting(), and m_runFitManager.

Referenced by FitSessionWidget::setSessionController().

Here is the call graph for this function:

setItem()

void FitSessionController::setItem

(

JobItem *

item

)

Definition at line 54 of file FitSessionController.cpp.

{
    if (m_jobItem && m_jobItem != item)
        throw Error("FitSuiteManager::setItem() -> Item was already set.");
 
    m_jobItem = item;
    ASSERT(m_jobItem);
 
    // no need to unsubscribe from jobItem on jobItem destroy. FitSessionManager deletes
    // controller right after the jobItem.
 
    // Propagates update interval from FitSuiteItem to fit observer.
    m_jobItem->fitSuiteItem()->mapper()->setOnPropertyChange(
        [this](const QString& name) {
            if (FitSuiteItem::isUpdateIntervalPropertyName(name))
                m_observer->setInterval(m_jobItem->fitSuiteItem()->updateInterval());
        },
        this);
}

References Error, JobItem::fitSuiteItem(), FitSuiteItem::isUpdateIntervalPropertyName(), m_jobItem, m_observer, SessionItem::mapper(), GUI::RealSpace::Particles::name(), ModelMapper::setOnPropertyChange(), and FitSuiteItem::updateInterval().

Here is the call graph for this function:

updateFitParameterValues

void FitSessionController::updateFitParameterValues ( const FitProgressInfo &  info )

privateslot

Definition at line 165 of file FitSessionController.cpp.

{
    QVector<double> values = QVector<double>::fromStdVector(info.parValues());
    FitParameterContainerItem* fitParContainer = m_jobItem->fitParameterContainerItem();
    fitParContainer->setValuesInParameterContainer(values, m_jobItem->parameterContainerItem());
}

References JobItem::fitParameterContainerItem(), m_jobItem, JobItem::parameterContainerItem(), FitProgressInfo::parValues(), and FitParameterContainerItem::setValuesInParameterContainer().

Referenced by onObserverUpdate().

Here is the call graph for this function:

updateIterationCount

void FitSessionController::updateIterationCount ( const FitProgressInfo &  info )

privateslot

Definition at line 156 of file FitSessionController.cpp.

{
    FitSuiteItem* fitSuiteItem = m_jobItem->fitSuiteItem();
    // FIXME FitFlowWidget updates chi2 and n_iteration on P_ITERATION_COUNT change
    // The order of two lines below is important
    fitSuiteItem->setChi2(info.chi2());
    fitSuiteItem->setIterationCount(info.iterationCount());
}

References FitProgressInfo::chi2(), JobItem::fitSuiteItem(), FitProgressInfo::iterationCount(), m_jobItem, FitSuiteItem::setChi2(), and FitSuiteItem::setIterationCount().

Referenced by onObserverUpdate().

Here is the call graph for this function:

updateLog

void FitSessionController::updateLog ( const FitProgressInfo &  info )

privateslot

Definition at line 172 of file FitSessionController.cpp.

{
    QString message = QString("NCalls:%1 chi2:%2 \n").arg(info.iterationCount()).arg(info.chi2());
    FitParameterContainerItem* fitParContainer = m_jobItem->fitParameterContainerItem();
    int index(0);
    QVector<double> values = QVector<double>::fromStdVector(info.parValues());
    for (FitParameterItem* item : fitParContainer->fitParameterItems()) {
        if (item->linkItems().empty())
            continue;
        QString parinfo = QString("      %1 %2\n").arg(item->displayName()).arg(values[index++]);
        message.append(parinfo);
    }
    m_fitlog->append(message.toStdString(), FitLogLevel::Default);
}

References FitProgressInfo::chi2(), Default, JobItem::fitParameterContainerItem(), FitParameterContainerItem::fitParameterItems(), FitProgressInfo::iterationCount(), m_fitlog, m_jobItem, and FitProgressInfo::parValues().

Referenced by onObserverUpdate().

Here is the call graph for this function:

Member Data Documentation

m_block_progress_update

bool FitSessionController::m_block_progress_update

private

Definition at line 65 of file FitSessionController.h.

m_fitlog

std::unique_ptr<FitLog> FitSessionController::m_fitlog

private

Definition at line 63 of file FitSessionController.h.

Referenced by fitLog(), onFittingError(), onFittingFinished(), onFittingStarted(), onObserverUpdate(), onStartFittingRequest(), and updateLog().

m_jobItem

JobItem* FitSessionController::m_jobItem

private

Definition at line 60 of file FitSessionController.h.

Referenced by onFittingError(), onFittingFinished(), onFittingStarted(), onObserverUpdate(), onStartFittingRequest(), setItem(), updateFitParameterValues(), updateIterationCount(), and updateLog().

m_objectiveBuilder

std::shared_ptr<FitObjectiveBuilder> FitSessionController::m_objectiveBuilder

private

Definition at line 64 of file FitSessionController.h.

Referenced by onStartFittingRequest().

m_observer

std::shared_ptr<GUIFitObserver> FitSessionController::m_observer

private

Definition at line 62 of file FitSessionController.h.

Referenced by FitSessionController(), onObserverUpdate(), onStartFittingRequest(), and setItem().

m_runFitManager

FitWorkerLauncher* FitSessionController::m_runFitManager

private

Definition at line 61 of file FitSessionController.h.

Referenced by FitSessionController(), onFittingError(), onFittingFinished(), onFittingStarted(), onStartFittingRequest(), and onStopFittingRequest().

---

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

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