JobView Class Reference

Description

The JobView class is a main view to show list of jobs, job results and widgets for real time and fitting activities.

Definition at line 37 of file JobView.h.

Inheritance diagram for JobView:

Collaboration diagram for JobView:

Public Slots
void	onFocusRequest (JobItem *jobItem)
void	onSelectionChanged (const QVector< JobItem * > &jobs)
	Propagates change in JobItem's selection down into main widgets. More...
void	setActivity (JobViewActivity activity)
	Sets docks visibility in accordance with required activity. More...

Signals
void	activityChanged (JobViewActivity activity)
void	focusRequest (int)

Public Member Functions
	JobView (MainWindow *mainWindow, ProjectDocument *document)
void	fillViewMenu (QMenu *menu)

Private Member Functions
void	connectActivityRelated ()
	Connects signal related to activity change. More...
void	connectJobRelated ()
	Connects signals related to JobItem. More...
void	connectSignals ()
void	createActions ()
void	createSubWindows ()
void	resetLayout ()
void	setAppropriateActivityForJob (JobItem *jobItem)
	Sets appropriate activity for new JobItem. More...

Private Attributes
QActionGroup	m_activityActions
DocksController *	m_docks
ProjectDocument *	m_document
FitActivityPanel *	m_fitActivityPanel = nullptr
JobMessagePanel *	m_jobMessagePanel = nullptr
JobRealTimeWidget *	m_jobRealTimeWidget = nullptr
JobResultsPresenter *	m_jobResultsPresenter = nullptr
JobSelectorWidget *	m_jobSelector = nullptr
JobProgressAssistant *	m_progressAssistant

Constructor & Destructor Documentation

JobView()

JobView::JobView	(	MainWindow *	mainWindow,
		ProjectDocument *	document
	)

Definition at line 30 of file JobView.cpp.

    : m_docks(new DocksController(this))
    , m_progressAssistant(new JobProgressAssistant(mainWindow, document->jobModel()))
    , m_activityActions(this)
    , m_document(document)
{
    setObjectName("JobView");
    createActions();
    createSubWindows();
    connectSignals();
}

References connectSignals(), createActions(), and createSubWindows().

Here is the call graph for this function:

Member Function Documentation

activityChanged

void JobView::activityChanged ( JobViewActivity  activity )

signal

Referenced by connectActivityRelated(), and setActivity().

connectActivityRelated()

void JobView::connectActivityRelated ( )

private

Connects signal related to activity change.

Definition at line 137 of file JobView.cpp.

{
    // Activity was changed: this -> JobResultsPresenter
    connect(this, &JobView::activityChanged, m_jobResultsPresenter,
            qOverload<JobViewActivity>(&JobResultsPresenter::setPresentation));
}

References activityChanged(), m_jobResultsPresenter, and JobResultsPresenter::setPresentation().

Referenced by connectSignals().

Here is the call graph for this function:

connectJobRelated()

void JobView::connectJobRelated ( )

private

Connects signals related to JobItem.

Definition at line 145 of file JobView.cpp.

{
    // Focus request: JobModel -> this
    connect(m_document->jobModel(), &JobModel::focusRequest, this, &JobView::onFocusRequest);
 
    // JobItem selection: JobSelectorWidget -> this
    connect(m_jobSelector, &JobSelectorWidget::selectedJobsChanged, this,
            &JobView::onSelectionChanged);
 
    connect(m_fitActivityPanel, &FitActivityPanel::showLog, m_jobMessagePanel,
            &JobMessagePanel::setLog);
 
    // activate view for the selected job at project opening
    m_jobSelector->selectedJobsChanged(m_jobSelector->selectedJobs());
}

References JobModel::focusRequest(), ProjectDocument::jobModel(), m_document, m_fitActivityPanel, m_jobMessagePanel, m_jobSelector, onFocusRequest(), onSelectionChanged(), JobSelectorWidget::selectedJobs(), JobSelectorWidget::selectedJobsChanged(), JobMessagePanel::setLog(), and FitActivityPanel::showLog().

Referenced by connectSignals().

Here is the call graph for this function:

connectSignals()

void JobView::connectSignals ( )

private

Definition at line 129 of file JobView.cpp.

{
    connectActivityRelated();
    connectJobRelated();
}

References connectActivityRelated(), and connectJobRelated().

Referenced by JobView().

Here is the call graph for this function:

createActions()

void JobView::createActions ( )

private

Definition at line 118 of file JobView.cpp.

{
    for (JobViewActivity activity : JobViewActivities::all()) {
        auto* action = new QAction(this);
        action->setText(JobViewActivities::name(activity));
        action->setCheckable(true);
        connect(action, &QAction::triggered, [=]() { setActivity(activity); });
        m_activityActions.addAction(action);
    }
}

References JobViewActivities::all(), m_activityActions, JobViewActivities::name(), and setActivity().

Referenced by JobView().

Here is the call graph for this function:

createSubWindows()

void JobView::createSubWindows ( )

private

Definition at line 98 of file JobView.cpp.

{
    m_jobResultsPresenter = new JobResultsPresenter(this);
    m_jobSelector = new JobSelectorWidget(m_document->jobModel(), this);
    m_jobRealTimeWidget = new JobRealTimeWidget(m_document->jobModel(), this);
    m_fitActivityPanel = new FitActivityPanel(this);
    m_jobMessagePanel = new JobMessagePanel(this);
 
    m_docks->addWidget(JobViewFlags::JOB_LIST_DOCK, m_jobSelector, Qt::LeftDockWidgetArea);
    m_docks->addWidget(JobViewFlags::REAL_TIME_DOCK, m_jobRealTimeWidget, Qt::RightDockWidgetArea);
    m_docks->addWidget(JobViewFlags::FIT_PANEL_DOCK, m_fitActivityPanel, Qt::RightDockWidgetArea);
    m_docks->addWidget(JobViewFlags::JOB_MESSAGE_DOCK, m_jobMessagePanel, Qt::BottomDockWidgetArea);
 
    m_fitActivityPanel->setRealTimeWidget(m_jobRealTimeWidget);
 
    setCentralWidget(m_jobResultsPresenter);
 
    resetLayout();
}

References DocksController::addWidget(), JobViewFlags::FIT_PANEL_DOCK, JobViewFlags::JOB_LIST_DOCK, JobViewFlags::JOB_MESSAGE_DOCK, ProjectDocument::jobModel(), m_docks, m_document, m_fitActivityPanel, m_jobMessagePanel, m_jobRealTimeWidget, m_jobResultsPresenter, m_jobSelector, JobViewFlags::REAL_TIME_DOCK, resetLayout(), and FitActivityPanel::setRealTimeWidget().

Referenced by JobView().

Here is the call graph for this function:

fillViewMenu()

void JobView::fillViewMenu

(

QMenu *

menu

)

Definition at line 42 of file JobView.cpp.

{
    menu->addActions(m_activityActions.actions());
    menu->addSeparator();
 
    m_docks->addDockActionsToMenu(menu);
 
    menu->addSeparator();
 
    auto* action = new QAction(menu);
    action->setText("Reset to default layout");
    connect(action, &QAction::triggered, this, &JobView::resetLayout);
    menu->addAction(action);
}

References DocksController::addDockActionsToMenu(), m_activityActions, m_docks, and resetLayout().

Here is the call graph for this function:

focusRequest

void JobView::focusRequest ( int  )

signal

Referenced by MainWindow::initViews(), and onFocusRequest().

onFocusRequest

void JobView::onFocusRequest ( JobItem *  jobItem )

slot

Definition at line 57 of file JobView.cpp.

{
    if (jobItem->runInBackground())
        return;
 
    QVector<JobItem*> jobs = m_jobSelector->selectedJobs();
    if (jobs.size() != 1 || jobItem != jobs.front()) {
        m_jobSelector->makeJobItemSelected(jobItem);
        setAppropriateActivityForJob(jobItem);
    }
 
    emit focusRequest(MainWindow::JOB);
}

References focusRequest(), MainWindow::JOB, m_jobSelector, JobSelectorWidget::makeJobItemSelected(), JobItem::runInBackground(), JobSelectorWidget::selectedJobs(), and setAppropriateActivityForJob().

Referenced by connectJobRelated().

Here is the call graph for this function:

onSelectionChanged

void JobView::onSelectionChanged ( const QVector< JobItem * > &  jobs )

slot

Propagates change in JobItem's selection down into main widgets.

Definition at line 88 of file JobView.cpp.

{
    JobItem* jobItem = nullptr;
    if (jobs.size() == 1)
        jobItem = jobs.front();
    m_jobResultsPresenter->setItem(jobItem);
    m_jobRealTimeWidget->setItem(jobItem);
    m_fitActivityPanel->setItem(jobItem);
}

References m_fitActivityPanel, m_jobRealTimeWidget, m_jobResultsPresenter, FitActivityPanel::setItem(), JobRealTimeWidget::setItem(), and JobResultsPresenter::setItem().

Referenced by connectJobRelated().

Here is the call graph for this function:

resetLayout()

void JobView::resetLayout ( )

private

Definition at line 177 of file JobView.cpp.

{
    m_docks->resetLayout();
    setActivity(JobViewActivity::JobView);
}

References JobView, m_docks, DocksController::resetLayout(), and setActivity().

Referenced by createSubWindows(), and fillViewMenu().

Here is the call graph for this function:

setActivity

void JobView::setActivity ( JobViewActivity  activity )

slot

Sets docks visibility in accordance with required activity.

Definition at line 73 of file JobView.cpp.

{
    QVector<JobViewFlags::Dock> docksToShow = JobViewActivities::activeDocks(activity);
 
    std::vector<int> docks_id;
    for (auto x : docksToShow)
        docks_id.push_back(static_cast<int>(x));
 
    m_docks->setVisibleDocks(docks_id);
    m_activityActions.actions()[static_cast<int>(activity)]->setChecked(true);
    emit activityChanged(activity);
}

References JobViewActivities::activeDocks(), activityChanged(), m_activityActions, m_docks, and DocksController::setVisibleDocks().

Referenced by createActions(), and resetLayout().

Here is the call graph for this function:

setAppropriateActivityForJob()

void JobView::setAppropriateActivityForJob ( JobItem *  jobItem )

private

Sets appropriate activity for new JobItem.

Definition at line 163 of file JobView.cpp.

{
    if (!jobItem)
        return;
 
    if (jobItem->isValidForFitting()) {
        // fitting presentation
        m_jobResultsPresenter->setPresentation(JobViewActivity::Fitting);
        // ALTERNATIVE:
        // fitting activity
        // setActivity(JobViewActivity::Fitting);
    }
}

References Fitting, JobItem::isValidForFitting(), m_jobResultsPresenter, and JobResultsPresenter::setPresentation().

Referenced by onFocusRequest().

Here is the call graph for this function:

Member Data Documentation

m_activityActions

QActionGroup JobView::m_activityActions

private

Definition at line 73 of file JobView.h.

Referenced by createActions(), fillViewMenu(), and setActivity().

m_docks

DocksController* JobView::m_docks

private

Definition at line 64 of file JobView.h.

Referenced by createSubWindows(), fillViewMenu(), resetLayout(), and setActivity().

m_document

ProjectDocument* JobView::m_document

private

Definition at line 74 of file JobView.h.

Referenced by connectJobRelated(), and createSubWindows().

m_fitActivityPanel

FitActivityPanel* JobView::m_fitActivityPanel = nullptr

private

Definition at line 70 of file JobView.h.

Referenced by connectJobRelated(), createSubWindows(), and onSelectionChanged().

m_jobMessagePanel

JobMessagePanel* JobView::m_jobMessagePanel = nullptr

private

Definition at line 71 of file JobView.h.

Referenced by connectJobRelated(), and createSubWindows().

m_jobRealTimeWidget

JobRealTimeWidget* JobView::m_jobRealTimeWidget = nullptr

private

Definition at line 69 of file JobView.h.

Referenced by createSubWindows(), and onSelectionChanged().

m_jobResultsPresenter

JobResultsPresenter* JobView::m_jobResultsPresenter = nullptr

private

Definition at line 68 of file JobView.h.

Referenced by connectActivityRelated(), createSubWindows(), onSelectionChanged(), and setAppropriateActivityForJob().

m_jobSelector

JobSelectorWidget* JobView::m_jobSelector = nullptr

private

Definition at line 67 of file JobView.h.

Referenced by connectJobRelated(), createSubWindows(), and onFocusRequest().

m_progressAssistant

JobProgressAssistant* JobView::m_progressAssistant

private

Definition at line 65 of file JobView.h.

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Job/JobView.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Job/JobView.cpp