ImportDataUtils.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/View/Import/ImportDataUtils.h
//! @brief     Defines ImportDataUtils namespace
//!
//! @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_VIEW_IMPORT_IMPORTDATAUTILS_H
#define BORNAGAIN_GUI_VIEW_IMPORT_IMPORTDATAUTILS_H
 
#include "Device/IO/IOFactory.h"
#include <QString>
#include <memory>
 
class Datafield;
class RealDataItem;
class InstrumentItem;
class AbstractDataLoader;
 
//! Provides utility methods to import data files.
 
namespace GUI::View::ImportDataUtils {
 
//! Imports 2D data, stores them as Datafield, and returns owning pointer.
std::unique_ptr<Datafield> Import2dData(const QString& fileName, IOFactory::LoaderSelector loader);
 
//! Imports 1D data into the given item.
 
//! Returns an error text if a fatal error occurred (discard item).
//! "Empty string" means "no fatal error" => imported item should be kept.
//! The imported item still can have errors, but they might be solvable
//! by different import settings or by using a different data loader.
//! Argument selectedLoader is the one which was selected in the open-file-dialog
//! (or null if none selected).
QString Import1dData(RealDataItem* realDataItem, const AbstractDataLoader* selectedLoader);
 
} // namespace GUI::View::ImportDataUtils
 
#endif // BORNAGAIN_GUI_VIEW_IMPORT_IMPORTDATAUTILS_H