DataItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Data/DataItem.h
//! @brief     Declares class DataItem
//!
//! @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_DATA_DATAITEM_H
#define BORNAGAIN_GUI_MODEL_DATA_DATAITEM_H
 
#include "Device/Data/Datafield.h"
#include "GUI/Model/BaseItem/SessionItem.h"
#include "GUI/Model/Descriptor/SelectionDescriptor.h"
#include "GUI/Support/IO/SaveLoadInterface.h"
#include <QDateTime>
#include <mutex>
 
class ComboProperty;
class ImportDataInfo;
class InstrumentItem;
 
//! Abstract base class for IntensityDataItem and SpecularDataItem.
//! Owns one simulated data set of type Datafield.
 
//! For experimental data, use RealDataItem.
 
class BA_CORE_API_ DataItem : public QObject, public SessionItem, public SaveLoadInterface {
    Q_OBJECT
private:
    static constexpr auto P_FILE_NAME{"FileName"};
    static constexpr auto P_AXES_UNITS{"Axes Units"};
 
public:
    Datafield* getDatafield() { return m_data.get(); }
    const Datafield* getDatafield() const { return m_data.get(); }
 
    //! The given pointer becomes owned by this class!!
    virtual void setDatafield(Datafield* data) = 0;
 
    //! Sets the raw data vector from external source.
    //! Checks only the equality of data size; no dimension checks are applied.
    void setRawDataVector(const std::vector<double>& data);
 
    using SaveLoadInterface::fileName;
    QString fileName() const override;
    void setFileName(const QString& filename);
    QDateTime lastModified() const override;
    bool containsNonXMLData() const override;
    bool loadData(const QString& projectDir) override;
    bool saveData(const QString& projectDir) override;
 
    void setLastModified(const QDateTime& dtime);
 
    QString selectedCoords() const;
 
    void setAxesUnits(const ComboProperty& units);
    SessionItem* getAxesUnitsItem() const;
    SelectionDescriptor<QString> axesUnits() const;
    static bool isAxesUnitsPropertyName(const QString& name);
    static void updateAxesUnits(SessionItem* item, const QString& name,
                                InstrumentItem* instrumentItem);
 
    virtual void setXaxisTitle(const QString& title) = 0;
    virtual void setYaxisTitle(const QString& title) = 0;
    virtual void setAxesRangeToData() = 0;
    virtual void updateCoords(const InstrumentItem* instrument) = 0;
    virtual std::vector<int> shape() const = 0;
 
    //! Resets data to the state defined by user (imported) data.
    virtual void reset(ImportDataInfo data) = 0;
 
signals:
    void datafieldChanged(Datafield* data);
    void rawDataVectorChanged(const std::vector<double>& data);
    void fileNameChanged(const QString& filename);
    void axesUnitsChanged(const ComboProperty& units);
 
protected:
    explicit DataItem(const QString& modelType);
 
    std::unique_ptr<Datafield> m_data; //!< simulation results
    QDateTime m_last_modified;
    std::mutex m_update_data_mutex;
};
 
#endif // BORNAGAIN_GUI_MODEL_DATA_DATAITEM_H