JobItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Job/JobItem.h
//! @brief     Defines class JobItem
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_JOB_JOBITEM_H
#define BORNAGAIN_GUI_MODEL_JOB_JOBITEM_H
 
#include "GUI/Model/BaseItem/SessionItem.h"
#include "GUI/Model/Device/InstrumentItems.h"
#include "GUI/Model/Job/ParameterTreeItems.h"
#include "GUI/Model/Model/SessionModel.h" // call to model() from templated fct
#include "GUI/Model/Sample/MaterialItems.h"
#include "GUI/Model/Sample/MultiLayerItem.h"
#include "GUI/Support/Data/JobStatus.h" // enum cannot be forward declared
#include "GUI/Support/Data/SimulationOptionsItem.h"
#include <QDateTime>
#include <optional>
 
class Data1DViewItem;
class DataItem;
class FitParameterContainerItem;
class FitSuiteItem;
class ISimulation;
class Instrument2DItem;
class InstrumentItem;
class IntensityDataItem;
class MaterialItemContainer;
class ParameterContainerItem;
class RealDataItem;
class SimulationOptionsItem;
class SimulationResult;
 
class BA_CORE_API_ JobItem : public QObject, public SessionItem {
    Q_OBJECT
private:
    static constexpr auto P_IDENTIFIER{"Identifier"};
    static constexpr auto P_INSTRUMENT_NAME{"Instrument"};
    static constexpr auto P_WITH_FITTING{"With fitting"};
    static constexpr auto P_STATUS{"Status"};
    static constexpr auto P_BEGIN_TIME{"Begin time"};
    static constexpr auto P_END_TIME{"End time"};
    static constexpr auto P_COMMENTS{"Comments"};
    static constexpr auto P_PROGRESS{"Progress"};
    static constexpr auto P_PRESENTATION_TYPE{"Presentation type"};
    static constexpr auto T_MATERIAL_CONTAINER{"Material container tag"};
    static constexpr auto T_OUTPUT{"Output tag"};
    static constexpr auto T_REALDATA{"Real Data tag"};
    static constexpr auto T_DATAVIEW{"Data View tag"};
    static constexpr auto T_FIT_SUITE{"Fit suite tag"};
 
public:
    static constexpr auto M_TYPE{"JobItem"};
 
    JobItem();
    ~JobItem();
 
    QString getIdentifier() const;
    void setIdentifier(const QString& identifier);
 
    QString jobName() const;
    void setJobName(const QString& name);
 
    IntensityDataItem* intensityDataItem();
    DataItem* dataItem();
    template <typename T>
    T* setDataType();
 
    JobStatus getStatus() const;
    void setStatus(JobStatus status);
 
    bool isIdle() const;
    bool isRunning() const;
    bool isCompleted() const;
    bool isCanceled() const;
    bool isFailed() const;
    bool isFitting() const;
    bool isValidForFitting();
 
    QDateTime beginTime() const;
    void setBeginTime(const QDateTime& begin_time);
 
    QDateTime endTime() const;
    void setEndTime(const QDateTime& end_time);
 
    /// if begin and end time are both available the duration in ms, otherwise empty
    std::optional<size_t> duration() const;
 
    QString getComments() const;
    void setComments(const QString& comments);
 
    int getProgress() const;
    void setProgress(int progress);
 
    bool runImmediately() const;
    bool runInBackground() const;
 
    MultiLayerItem* sampleItem();
    MultiLayerItem* copySampleIntoJob(const MultiLayerItem* sample);
 
    Instrument2DItem* instrument2DItem();
    InstrumentItem* instrumentItem() const;
    InstrumentItem* copyInstrumentIntoJob(const InstrumentItem* instrument);
 
    const SimulationOptionsItem& simulationOptionsItem() const;
    void copySimulationOptionsIntoJob(const SimulationOptionsItem& options);
 
    void setResults(const SimulationResult& result);
 
    FitSuiteItem* fitSuiteItem();
    FitSuiteItem* createFitSuiteItem();
 
    ParameterContainerItem* parameterContainerItem();
    const ParameterContainerItem* parameterContainerItem() const;
    FitParameterContainerItem* fitParameterContainerItem();
 
    RealDataItem* realDataItem();
    RealDataItem* copyRealDataIntoJob(const RealDataItem* real_data);
    RealDataItem* createRealDataItem();
 
    Data1DViewItem* dataItemView();
    void addDataViewItem(Data1DViewItem* data_view);
    Data1DViewItem* createDataViewItem();
 
    QString sampleName() const;
 
    QString instrumentName() const;
    void setInstrumentName(const QString& name);
 
    QString presentationType() const;
    void setPresentationType(const QString& type);
 
    void writeNonSessionItems(QXmlStreamWriter* writer) const override;
    void readNonSessionItems(QXmlStreamReader* reader) override;
 
    bool isSpecularJob() const;
 
    friend class JobModel;
 
signals:
    void jobDestroyed();
    void jobNameChanged(const QString& name);
    void jobStatusChanged(const JobStatus status);
    void jobBeginTimeChanged(const QDateTime& begin_time);
    void jobEndTimeChanged(const QDateTime& end_time);
    void jobIdentifierChanged(const QString& identifier);
    void jobCommentsChanged(const QString& comments);
    void jobProgressChanged(int progress);
    void jobInstrumentNameChanged(const QString& name);
    void jobPresentationTypeChanged(const QString& type);
 
private:
    void updateIntensityDataFileName();
 
    SimulationOptionsItem m_simulationOptionsItem;
    ParameterContainerItem m_parameterContainer;
    MultiLayerItem m_sampleItem;
    std::unique_ptr<InstrumentItem> m_instrument;
};
 
template <typename T>
T* JobItem::setDataType()
{
    static_assert(std::is_base_of<DataItem, T>::value, "Class must be derived from DataItem");
 
    return model()->insertItem<T>(this, -1, T_OUTPUT);
}
 
#endif // BORNAGAIN_GUI_MODEL_JOB_JOBITEM_H