JobResultsPresenter Class Reference

Presents results of job (JobItem) using stack of different widgets and combo box in the right top corner of JobView, to switch between widgets. More...

Inheritance diagram for JobResultsPresenter:

Collaboration diagram for JobResultsPresenter:

Public Types
using	factory_function_t = std::function< SessionItemWidget *()>

Public Member Functions
	JobResultsPresenter (QWidget *parent=nullptr)
virtual QList< QAction * >	actionList ()
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
void	registerWidget (const QString &presentationType, factory_function_t)
virtual void	setItem (SessionItem *item)
void	setPresentation (const QString &presentationType) override
	Sets stack to show widget corresponding to given presentation. More...
void	setPresentation (JobViewFlags::EActivities activity)
void	setToolBarVisible (bool value)

Protected Member Functions
QStringList	activePresentationList (SessionItem *item) override
	Returns list of presentation types, available for given item. More...
virtual void	hideEvent (QHideEvent *)
QString	itemPresentation () const override
	Presentation which should be shown for current item. More...
QStringList	presentationList (SessionItem *item) override
	Returns full list of presentations available for given item. More...
QString	selectedPresentation () const
	Presentation selected in combo selector. More...
virtual void	showEvent (QShowEvent *)
void	subscribeToItem ()
virtual void	unsubscribeFromItem ()

Private Slots
void	onComboChanged (const QString &name)

Private Member Functions
QStringList	defaultActivePresentationsOfInstrument (InstrumentItem *instrumentItem)
QString	defaultPresentationOfInstrument (InstrumentItem *instrumentItem)
QString	fitPresentationOfInstrument (InstrumentItem *instrumentItem)
void	setSizeToCurrentWidget ()
	Resizes QStackedWidget to currently active page. More...

Private Attributes
SessionItemController *	m_itemController
QMap< QString, SessionItemWidget * >	m_presentationTypeToWidget
QStackedWidget *	m_stackedWidget
ItemComboToolBar *	m_toolBar
IFactory< QString, SessionItemWidget >	m_widgetFactory

Detailed Description

Presents results of job (JobItem) using stack of different widgets and combo box in the right top corner of JobView, to switch between widgets.

Definition at line 26 of file JobResultsPresenter.h.

Member Typedef Documentation

factory_function_t

using ItemComboWidget::factory_function_t = std::function<SessionItemWidget*()>

inherited

Definition at line 39 of file ItemComboWidget.h.

Constructor & Destructor Documentation

JobResultsPresenter()

JobResultsPresenter::JobResultsPresenter ( QWidget *  parent = nullptr )

explicit

Definition at line 25 of file JobResultsPresenter.cpp.

                                                        : ItemComboWidget(parent)
{
    registerWidget("Color Map", create_new<IntensityDataWidget>);
    registerWidget("Projections", create_new<IntensityDataProjectionsWidget>);
    registerWidget("Fit 1D Data", create_new<FitComparisonWidget1D>);
    registerWidget("Fit 2D Data", create_new<FitComparisonWidget>);
    registerWidget("Reflectometry", create_new<SpecularDataWidget>);
}

References ItemComboWidget::registerWidget().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SessionItemWidget::actionList ( )

virtualinherited

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

Definition at line 36 of file SessionItemWidget.cpp.

{
    return QList<QAction*>();
}

Referenced by ItemComboWidget::setPresentation().

activePresentationList()

QStringList JobResultsPresenter::activePresentationList ( SessionItem *  item )

overrideprotectedvirtual

Returns list of presentation types, available for given item.

JobItem with fitting abilities is valid for IntensityDataWidget and FitComparisonWidget.

Reimplemented from ItemComboWidget.

Definition at line 79 of file JobResultsPresenter.cpp.

{
    JobItem* jobItem = dynamic_cast<JobItem*>(item);
    if (!jobItem)
        return {};
 
    ASSERT(jobItem->instrumentItem() != nullptr);
 
    auto result = defaultActivePresentationsOfInstrument(jobItem->instrumentItem());
 
    if (jobItem->isValidForFitting())
        result << fitPresentationOfInstrument(jobItem->instrumentItem());
 
    return result;
}

References ASSERT, defaultActivePresentationsOfInstrument(), fitPresentationOfInstrument(), JobItem::instrumentItem(), and JobItem::isValidForFitting().

Here is the call graph for this function:

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 RectangularDetectorEditor::detectorItem(), SphericalDetectorEditor::detectorItem(), FitFlowWidget::fitSuiteItem(), DistributionEditor::groupItem(), DepthProbeInstrumentEditor::instrumentItem(), EnvironmentEditor::instrumentItem(), GISASBeamEditor::instrumentItem(), GISASDetectorEditor::instrumentItem(), GISASInstrumentEditor::instrumentItem(), OffSpecularBeamEditor::instrumentItem(), OffSpecularInstrumentEditor::instrumentItem(), PolarizationAnalysisEditor::instrumentItem(), SpecularBeamEditor::instrumentItem(), SpecularInstrumentEditor::instrumentItem(), RealDataMaskWidget::intensityDataItem(), IntensityDataCanvas::intensityDataItem(), IntensityDataProjectionsWidget::intensityDataItem(), IntensityDataWidget::intensityDataItem(), ProjectionsPlot::intensityItem(), ColorMap::intensityItem(), DetectorPresenter::itemPresentation(), InstrumentPresenter::itemPresentation(), itemPresentation(), FitComparisonWidget::jobItem(), FitComparisonWidget1D::jobItem(), FitParameterWidget::jobItem(), RunFitControlWidget::jobItem(), JobPropertiesWidget::jobItem(), ParameterTuningWidget::jobItem(), SpecularDataImportWidget::realDataItem(), ItemComboWidget::setPresentation(), setPresentation(), SpecularDataCanvas::specularDataItem(), SpecularDataImportWidget::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), ItemComboWidget::subscribeToItem(), DistributionEditor::subscribeToItem(), GISASDetectorEditor::subscribeToItem(), PolarizationAnalysisEditor::subscribeToItem(), IntensityDataPropertyWidget::subscribeToItem(), JobPropertiesWidget::subscribeToItem(), ProjectionsPropertyPanel::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:

defaultActivePresentationsOfInstrument()

QStringList JobResultsPresenter::defaultActivePresentationsOfInstrument ( InstrumentItem *  instrumentItem )

private

Definition at line 120 of file JobResultsPresenter.cpp.

{
    if (instrumentItem->is<SpecularInstrumentItem>())
        return {"Reflectometry"};
 
    return {"Color Map", "Projections"};
}

References SessionItem::is().

Referenced by activePresentationList(), and presentationList().

Here is the call graph for this function:

defaultPresentationOfInstrument()

QString JobResultsPresenter::defaultPresentationOfInstrument ( InstrumentItem *  instrumentItem )

private

Definition at line 111 of file JobResultsPresenter.cpp.

{
    if (instrumentItem->is<SpecularInstrumentItem>())
        return "Reflectometry";
 
    return "Color Map";
}

References SessionItem::is().

Referenced by setPresentation().

Here is the call graph for this function:

fitPresentationOfInstrument()

QString JobResultsPresenter::fitPresentationOfInstrument ( InstrumentItem *  instrumentItem )

private

Definition at line 128 of file JobResultsPresenter.cpp.

{
    if (instrumentItem->is<SpecularInstrumentItem>())
        return "Fit 1D Data";
 
    return "Fit 2D Data";
}

References SessionItem::is().

Referenced by activePresentationList(), presentationList(), and setPresentation().

Here is the call graph for this function:

hideEvent()

void SessionItemWidget::hideEvent ( QHideEvent *  )

protectedvirtualinherited

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:

itemPresentation()

QString JobResultsPresenter::itemPresentation ( ) const

overrideprotectedvirtual

Presentation which should be shown for current item.

Reimplemented from ItemComboWidget.

Definition at line 34 of file JobResultsPresenter.cpp.

{
    if (!currentItem())
        return {};
 
    const auto& value = currentItem()->getItemValue(JobItem::P_PRESENTATION_TYPE);
    return value.isValid() ? value.toString() : selectedPresentation();
}

References SessionItemWidget::currentItem(), SessionItem::getItemValue(), JobItem::P_PRESENTATION_TYPE, and ItemComboWidget::selectedPresentation().

Here is the call graph for this function:

onComboChanged

void ItemComboWidget::onComboChanged ( const QString &  name )

privateslotinherited

Definition at line 119 of file ItemComboWidget.cpp.

{
    setPresentation(selectedPresentation());
}

References ItemComboWidget::selectedPresentation(), and ItemComboWidget::setPresentation().

Referenced by ItemComboWidget::ItemComboWidget().

Here is the call graph for this function:

presentationList()

QStringList JobResultsPresenter::presentationList ( SessionItem *  item )

overrideprotectedvirtual

Returns full list of presentations available for given item.

Reimplemented from ItemComboWidget.

Definition at line 95 of file JobResultsPresenter.cpp.

{
    JobItem* jobItem = dynamic_cast<JobItem*>(item);
    if (!jobItem)
        return {};
 
    ASSERT(jobItem->instrumentItem() != nullptr);
 
    auto result = defaultActivePresentationsOfInstrument(jobItem->instrumentItem());
    auto addon = fitPresentationOfInstrument(jobItem->instrumentItem());
    if (!addon.isEmpty())
        result << addon;
 
    return result;
}

References ASSERT, defaultActivePresentationsOfInstrument(), fitPresentationOfInstrument(), and JobItem::instrumentItem().

Here is the call graph for this function:

registerWidget()

void ItemComboWidget::registerWidget ( const QString &  presentationType, factory_function_t  f  )

inherited

Definition at line 43 of file ItemComboWidget.cpp.

{
    m_widgetFactory.registerItem(presentationType, f);
}

References ItemComboWidget::m_widgetFactory, and IFactory< Key, AbstractProduct >::registerItem().

Referenced by DetectorPresenter::DetectorPresenter(), InstrumentPresenter::InstrumentPresenter(), JobResultsPresenter(), and RealDataPresenter::RealDataPresenter().

Here is the call graph for this function:

selectedPresentation()

QString ItemComboWidget::selectedPresentation ( ) const

protectedinherited

Presentation selected in combo selector.

Definition at line 107 of file ItemComboWidget.cpp.

{
    return m_toolBar->currentPresentation();
}

References ItemComboToolBar::currentPresentation(), and ItemComboWidget::m_toolBar.

Referenced by ItemComboWidget::itemPresentation(), itemPresentation(), and ItemComboWidget::onComboChanged().

Here is the call graph for this function:

setItem()

void SessionItemWidget::setItem ( SessionItem *  item )

virtualinherited

Reimplemented in SpecularPlotCanvas, SpecularDataImportWidget, SpecularDataWidget, IntensityDataWidget, SpecularDataCanvas, ProjectionsWidget, 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 IntensityDataWidget::onFFTAction(), JobSelectorWidget::onSelectionChanged(), ProjectionsEditor::resetContext(), ProjectionsEditor::setContext(), MaskGraphicsProxy::setIntensityItem(), FitSessionWidget::setItem(), Plot1DCanvas::setItem(), InstrumentEditorWidget::setItem(), ColorMapCanvas::setItem(), IntensityDataCanvas::setItem(), ProjectionsWidget::setItem(), SpecularDataCanvas::setItem(), DistributionDialog::setItem(), IntensityDataWidget::setItem(), SpecularDataWidget::setItem(), SpecularDataImportWidget::setItem(), SpecularPlotCanvas::setItem(), ItemComboWidget::setPresentation(), GISASInstrumentEditor::subscribeToItem(), OffSpecularInstrumentEditor::subscribeToItem(), SpecularInstrumentEditor::subscribeToItem(), FitComparisonWidget::subscribeToItem(), FitComparisonWidget1D::subscribeToItem(), and GISASDetectorEditor::updateDetectorPresenter().

Here is the call graph for this function:

setPresentation() [1/2]

void JobResultsPresenter::setPresentation ( const QString &  presentationType )

overridevirtual

Sets stack to show widget corresponding to given presentation.

Reimplemented from ItemComboWidget.

Definition at line 43 of file JobResultsPresenter.cpp.

{
    if (!currentItem())
        return;
 
    ItemComboWidget::setPresentation(presentationType);
    currentItem()->setItemValue(JobItem::P_PRESENTATION_TYPE, presentationType);
}

References SessionItemWidget::currentItem(), JobItem::P_PRESENTATION_TYPE, SessionItem::setItemValue(), and ItemComboWidget::setPresentation().

Referenced by setPresentation().

Here is the call graph for this function:

setPresentation() [2/2]

void JobResultsPresenter::setPresentation

(

JobViewFlags::EActivities

activity

)

Definition at line 52 of file JobResultsPresenter.cpp.

{
    if (!currentItem())
        return;
 
    JobItem* jobItem = dynamic_cast<JobItem*>(currentItem());
    if (!jobItem)
        return;
 
    QString presentation;
    switch (activity) {
    case JobViewFlags::FITTING_ACTIVITY:
        presentation = fitPresentationOfInstrument(jobItem->instrumentItem());
        break;
 
    case JobViewFlags::REAL_TIME_ACTIVITY:
    case JobViewFlags::JOB_VIEW_ACTIVITY:
        presentation = defaultPresentationOfInstrument(jobItem->instrumentItem());
        break;
    }
 
    setPresentation(presentation);
}

References SessionItemWidget::currentItem(), defaultPresentationOfInstrument(), fitPresentationOfInstrument(), JobViewFlags::FITTING_ACTIVITY, JobItem::instrumentItem(), JobViewFlags::JOB_VIEW_ACTIVITY, JobViewFlags::REAL_TIME_ACTIVITY, and setPresentation().

Here is the call graph for this function:

setSizeToCurrentWidget()

void ItemComboWidget::setSizeToCurrentWidget ( )

privateinherited

Resizes QStackedWidget to currently active page.

Definition at line 126 of file ItemComboWidget.cpp.

{
    for (int i = 0; i < m_stackedWidget->count(); ++i) {
        // determine the vertical size policy
        QSizePolicy::Policy policy = QSizePolicy::Ignored;
        if (i == m_stackedWidget->currentIndex())
            policy = QSizePolicy::Expanding;
 
        // update the size policy
        auto page = m_stackedWidget->widget(i);
        page->setSizePolicy(policy, policy);
    }
}

References ItemComboWidget::m_stackedWidget.

Referenced by ItemComboWidget::setPresentation().

setToolBarVisible()

void ItemComboWidget::setToolBarVisible ( bool  value )

inherited

Definition at line 76 of file ItemComboWidget.cpp.

{
    m_toolBar->setVisible(value);
}

References ItemComboWidget::m_toolBar.

Referenced by DetectorPresenter::DetectorPresenter(), and InstrumentPresenter::InstrumentPresenter().

showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )

protectedvirtualinherited

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 ItemComboWidget::subscribeToItem ( )

protectedvirtualinherited

Reimplemented from SessionItemWidget.

Definition at line 112 of file ItemComboWidget.cpp.

{
    m_toolBar->setPresentationList(presentationList(currentItem()),
                                   activePresentationList(currentItem()));
    setPresentation(itemPresentation());
}

References ItemComboWidget::activePresentationList(), SessionItemWidget::currentItem(), ItemComboWidget::itemPresentation(), ItemComboWidget::m_toolBar, ItemComboWidget::presentationList(), ItemComboWidget::setPresentation(), and ItemComboToolBar::setPresentationList().

Here is the call graph for this function:

unsubscribeFromItem()

virtual void SessionItemWidget::unsubscribeFromItem ( )

inlineprotectedvirtualinherited

Reimplemented in SpecularPlot, Plot1D, ColorMap, FitComparisonWidget1D, FitComparisonWidget, ProjectionsPropertyPanel, JobPropertiesWidget, ProjectionsPlot, IntensityDataPropertyWidget, IntensityDataProjectionsWidget, SphericalDetectorEditor, SpecularBeamEditor, RectangularDetectorEditor, PolarizationAnalysisEditor, OffSpecularBeamEditor, GISASDetectorEditor, GISASBeamEditor, EnvironmentEditor, DepthProbeInstrumentEditor, RealDataMaskWidget, RunFitControlWidget, and FitFlowWidget.

Definition at line 44 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

Member Data Documentation

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_presentationTypeToWidget

QMap<QString, SessionItemWidget*> ItemComboWidget::m_presentationTypeToWidget

privateinherited

Definition at line 68 of file ItemComboWidget.h.

Referenced by ItemComboWidget::setPresentation().

m_stackedWidget

QStackedWidget* ItemComboWidget::m_stackedWidget

privateinherited

Definition at line 65 of file ItemComboWidget.h.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::setPresentation(), and ItemComboWidget::setSizeToCurrentWidget().

m_toolBar

ItemComboToolBar* ItemComboWidget::m_toolBar

privateinherited

Definition at line 64 of file ItemComboWidget.h.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::selectedPresentation(), ItemComboWidget::setPresentation(), ItemComboWidget::setToolBarVisible(), and ItemComboWidget::subscribeToItem().

m_widgetFactory

IFactory<QString, SessionItemWidget> ItemComboWidget::m_widgetFactory

privateinherited

Definition at line 67 of file ItemComboWidget.h.

Referenced by ItemComboWidget::registerWidget(), and ItemComboWidget::setPresentation().

---

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

• /home/www/ba/GUI/coregui/Views/JobWidgets/JobResultsPresenter.h
• /home/www/ba/GUI/coregui/Views/JobWidgets/JobResultsPresenter.cpp