FitSessionController Class Reference

Controls all activity related to the single fitting task for JobItem. More...

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

Detailed 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.

Constructor & Destructor Documentation

FitSessionController()

FitSessionController::FitSessionController

(

QObject *

parent = nullptr

)

Definition at line 30 of file FitSessionController.cpp.

    : QObject(parent)
    , m_jobItem(nullptr)
    , m_runFitManager(new FitWorkerLauncher(this))
    , m_observer(new GUIFitObserver)
    , m_fitlog(new FitLog)
    , 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 ( )

default

Member Function Documentation

fitLog()

FitLog * FitSessionController::fitLog

(

)

Definition at line 94 of file FitSessionController.cpp.

{
    return m_fitlog.get();
}

References m_fitlog.

Referenced by FitSessionManager::disableLogging(), and FitSessionManager::sessionController().

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 149 of file FitSessionController.cpp.

{
    QString message;
    message.append("Current settings cause fitting failure.\n\n");
    message.append(text);
    m_fitlog->append(message.toStdString(), FitLogFlags::ERROR);
 
    emit fittingError(message);
}

References FitLogFlags::ERROR, fittingError(), and m_fitlog.

Referenced by FitSessionController().

onFittingFinished

void FitSessionController::onFittingFinished ( )

privateslot

Definition at line 135 of file FitSessionController.cpp.

{
    if (m_jobItem->getStatus() != "Failed")
        m_jobItem->setStatus("Completed");
    m_jobItem->setEndTime(GUIHelpers::currentDateTime());
    m_jobItem->setProgress(100);
    m_jobItem->setDuration(m_runFitManager->getDuration());
 
    if (m_jobItem->isCompleted())
        m_fitlog->append("Done", FitLogFlags::SUCCESS);
 
    emit fittingFinished();
}

References GUIHelpers::currentDateTime(), fittingFinished(), FitWorkerLauncher::getDuration(), JobItem::getStatus(), JobItem::isCompleted(), m_fitlog, m_jobItem, m_runFitManager, JobItem::setDuration(), JobItem::setEndTime(), JobItem::setProgress(), JobItem::setStatus(), and FitLogFlags::SUCCESS.

Referenced by FitSessionController().

Here is the call graph for this function:

onFittingStarted

void FitSessionController::onFittingStarted ( )

privateslot

Definition at line 122 of file FitSessionController.cpp.

{
    m_fitlog->clearLog();
 
    m_jobItem->setStatus("Fitting");
    m_jobItem->setProgress(0);
    m_jobItem->setBeginTime(GUIHelpers::currentDateTime());
    m_jobItem->setEndTime(QString());
    m_jobItem->setDuration(0);
 
    emit fittingStarted();
}

References GUIHelpers::currentDateTime(), fittingStarted(), m_fitlog, m_jobItem, JobItem::setBeginTime(), JobItem::setDuration(), 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 104 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(), FitLogFlags::DEFAULT);
 
    m_observer->finishedPlotting();
}

References JobItem::dataItem(), FitLogFlags::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()->getItemValue(FitSuiteItem::P_UPDATE_INTERVAL).toInt());
        m_objectiveBuilder->attachObserver(m_observer);
        m_observer->finishedPlotting();
        m_runFitManager->runFitting(m_objectiveBuilder);
 
    } catch (std::exception& e) {
        m_jobItem->setStatus("Failed");
        m_fitlog->append(e.what(), FitLogFlags::ERROR);
        emit fittingError(QString::fromStdString(e.what()));
    }
}

References FitLogFlags::ERROR, JobItem::fitSuiteItem(), fittingError(), SessionItem::getItemValue(), m_fitlog, m_jobItem, m_objectiveBuilder, m_observer, m_runFitManager, FitSuiteItem::P_UPDATE_INTERVAL, FitWorkerLauncher::runFitting(), and JobItem::setStatus().

Referenced by FitSessionWidget::setSessionController().

Here is the call graph for this function:

onStopFittingRequest

void FitSessionController::onStopFittingRequest ( )

slot

Definition at line 99 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 51 of file FitSessionController.cpp.

{
    if (m_jobItem && m_jobItem != item)
        throw GUIHelpers::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 (name == FitSuiteItem::P_UPDATE_INTERVAL) {
                m_observer->setInterval(m_jobItem->fitSuiteItem()
                                            ->getItemValue(FitSuiteItem::P_UPDATE_INTERVAL)
                                            .toInt());
            }
        },
        this);
}

References ASSERT, JobItem::fitSuiteItem(), SessionItem::getItemValue(), m_jobItem, m_observer, SessionItem::mapper(), RealSpace::Particles::name(), FitSuiteItem::P_UPDATE_INTERVAL, and ModelMapper::setOnPropertyChange().

Here is the call graph for this function:

updateFitParameterValues

void FitSessionController::updateFitParameterValues ( const FitProgressInfo &  info )

privateslot

Definition at line 168 of file FitSessionController.cpp.

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

References JobItem::fitParameterContainerItem(), GUIHelpers::fromStdVector(), 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 159 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->setItemValue(FitSuiteItem::P_CHI2, info.chi2());
    fitSuiteItem->setItemValue(FitSuiteItem::P_ITERATION_COUNT, info.iterationCount());
}

References FitProgressInfo::chi2(), JobItem::fitSuiteItem(), FitProgressInfo::iterationCount(), m_jobItem, FitSuiteItem::P_CHI2, FitSuiteItem::P_ITERATION_COUNT, and SessionItem::setItemValue().

Referenced by onObserverUpdate().

Here is the call graph for this function:

updateLog

void FitSessionController::updateLog ( const FitProgressInfo &  info )

privateslot

Definition at line 175 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 = GUIHelpers::fromStdVector(info.parValues());
    for (auto item : fitParContainer->getItems(FitParameterContainerItem::T_FIT_PARAMETERS)) {
        if (item->getItems(FitParameterItem::T_LINK).empty())
            continue;
        QString parinfo = QString("      %1 %2\n").arg(item->displayName()).arg(values[index++]);
        message.append(parinfo);
    }
    m_fitlog->append(message.toStdString(), FitLogFlags::DEFAULT);
}

References FitProgressInfo::chi2(), FitLogFlags::DEFAULT, JobItem::fitParameterContainerItem(), GUIHelpers::fromStdVector(), SessionItem::getItems(), FitProgressInfo::iterationCount(), m_fitlog, m_jobItem, FitProgressInfo::parValues(), FitParameterContainerItem::T_FIT_PARAMETERS, and FitParameterItem::T_LINK.

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 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(), onFittingFinished(), onStartFittingRequest(), and onStopFittingRequest().

---

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

• /home/www/ba/GUI/coregui/Views/FitWidgets/FitSessionController.h
• /home/www/ba/GUI/coregui/Views/FitWidgets/FitSessionController.cpp