ImportDataInfo.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Support/IO/ImportDataInfo.h
//! @brief     Defines ImportDataInfo helper struct
//!
//! @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_SUPPORT_IO_IMPORTDATAINFO_H
#define BORNAGAIN_GUI_SUPPORT_IO_IMPORTDATAINFO_H
 
#include "Device/Coord/Tags.h"
#include <QString>
#include <memory>
 
class Datafield;
 
//! Carries information about loaded data.
 
class ImportDataInfo {
public:
    ImportDataInfo(std::unique_ptr<Datafield> data, Coords units);
    ImportDataInfo(Datafield&& data, Coords units);
    ImportDataInfo(std::unique_ptr<Datafield> data, const QString& units);
    ImportDataInfo(ImportDataInfo&& other);
    ~ImportDataInfo();
 
    //! True if the contained data is not nullptr (no info about empty data)
    operator bool() const;
 
    std::unique_ptr<Datafield> clonedData() const&;
    std::unique_ptr<Datafield> intensityData() &&;
 
    //! Returns number of dimensions.
    size_t dataRank() const;
 
    QString unitsLabel() const;
    QString axisLabel(size_t axis_index) const;
 
private:
    void checkValidity();
 
private:
    std::unique_ptr<Datafield> m_data;
    const Coords m_coords;
};
 
#endif // BORNAGAIN_GUI_SUPPORT_IO_IMPORTDATAINFO_H