Implements the legacy importer from BornAgain with no user interaction. More...

Inheritance diagram for AutomaticDataLoader1D:

Collaboration diagram for AutomaticDataLoader1D:

Signals
void	contentsProcessed ()
	Emitted whenever contents have been processed. More...

void	importSettingsChanged ()
	Emitted whenever an import setting changed. More...

Public Member Functions
virtual void	applyImportSettings ()
	Read all values from the properties UI into the internal variables. More...

virtual AbstractDataLoader *	clone () const override
	Create a complete clone, including all internal states. More...

virtual AbstractDataLoaderResultModel *	createResultModel () const override
	Create a table model which contains the import information like original file content, raw content, processed content The returned pointer will be owned by the caller. More...

virtual QByteArray	defaultImportSettings () const
	Return the default import settings. More...

virtual void	deserialize (const QByteArray &data) override
	Initialize from serialization data. More...

virtual QByteArray	fileContent () const override
	Returns the original file content. More...

virtual void	guessSettings ()
	Guess appropriate settings (for example the separator in a CSV file). More...

virtual void	initWithDefaultImportSettings ()
	Set import settings to defaults. More...

virtual QStringList	lineUnrelatedErrors () const override
	Errors not related to a particular line. More...

virtual QString	name () const override
	The name shown in the format selection combo. More...

virtual int	numErrors () const override
	Number of errors found while processing the content. More...

virtual int	numLineRelatedErrors () const
	Number of errors related to a specific line. More...

virtual QString	persistentClassName () const override
	A name which can be used for save/load purposes (which will not change ever more) More...

virtual void	populateImportSettingsWidget (QWidget *parent)
	Fills the widget on the import dialog pane. More...

virtual void	processContents () override
	Process the file contents. More...

RealDataItem *	realDataItem ()
	The real data item on which the import shall work. More...

const RealDataItem *	realDataItem () const
	The real data item on which the import shall work. More...

virtual QByteArray	serialize () const override
	Returns every internal setting so it can be restored completely. More...

virtual void	setFileContents (const QByteArray &fileContent) override
	Sets the file contents to be imported. More...

void	setRealDataItem (RealDataItem *item)
	Define the real data item on which the import shall work. More...

Protected Types
enum class	Error { DifferendNumberOfColumns }

Protected Attributes
RealDataItem *	m_item

Private Attributes
QString	m_error

QByteArray	m_fileContent

Detailed Description

Implements the legacy importer from BornAgain with no user interaction.

Definition at line 22 of file AutomaticDataLoader1D.h.

Member Enumeration Documentation

◆ Error

enum AbstractDataLoader::Error

strongprotectedinherited

Enumerator
DifferendNumberOfColumns

Definition at line 119 of file AbstractDataLoader.h.

119 { DifferendNumberOfColumns };

Member Function Documentation

◆ applyImportSettings()

void AbstractDataLoader::applyImportSettings ( )

virtualinherited

Read all values from the properties UI into the internal variables.

Reimplemented in QREDataLoader.

Definition at line 20 of file AbstractDataLoader.cpp.

20 {}

Referenced by DataLoaders1D::cloneAsUserDefinedLoader(), and SpecularDataImportWidget::onPropertiesChanged().

◆ clone()

AbstractDataLoader * AutomaticDataLoader1D::clone ( ) const

overridevirtual

Create a complete clone, including all internal states.

Implements AbstractDataLoader.

Definition at line 35 of file AutomaticDataLoader1D.cpp.

 {
     auto loader = new AutomaticDataLoader1D();
     loader->deserialize(serialize());
     return loader;
 }

References serialize().

Here is the call graph for this function:

◆ contentsProcessed

void AbstractDataLoader::contentsProcessed ( )

signalinherited

Emitted whenever contents have been processed.

Referenced by processContents(), QREDataLoader::processContents(), and RealDataItem::setDataLoader().

◆ createResultModel()

AbstractDataLoaderResultModel * AutomaticDataLoader1D::createResultModel ( ) const

overridevirtual

Create a table model which contains the import information like original file content, raw content, processed content The returned pointer will be owned by the caller.

This base class' implementation does nothing (return nullptr).

Reimplemented from AbstractDataLoader.

Definition at line 109 of file AutomaticDataLoader1D.cpp.

 {
     return new AutomaticDataLoader1DResultModel(m_item);
 }

References AbstractDataLoader::m_item.

◆ defaultImportSettings()

QByteArray AbstractDataLoader::defaultImportSettings ( ) const

virtualinherited

Return the default import settings.

Definition at line 31 of file AbstractDataLoader.cpp.

 {
     std::unique_ptr<AbstractDataLoader> cloned(clone());
     cloned->initWithDefaultImportSettings();
     return cloned->serialize();
 }

References AbstractDataLoader::clone().

Here is the call graph for this function:

◆ deserialize()

void AutomaticDataLoader1D::deserialize ( const QByteArray & data )

overridevirtual

Initialize from serialization data.

If any error occurred, then a DeserializationException has to be thrown. The complete state has to be restored. Therefore if e.g. errors occurred in the former serialization, but errors are not serialized, then they have to be regenerated/recalculated in here.

Reimplemented from AbstractDataLoader.

Definition at line 55 of file AutomaticDataLoader1D.cpp.

 {
     m_fileContent.clear();
     m_error.clear();
  
     QDataStream s(data);
     s.setVersion(QDataStream::Qt_5_12);
  
     quint8 version;
     s >> version;
  
     if (version == 1) {
         s >> m_fileContent;
         s >> m_error;
     } else
         throw DeserializationException::tooNew();
  
     if (s.status() != QDataStream::Ok)
         throw DeserializationException::streamError();
 }

References m_error, m_fileContent, DeserializationException::streamError(), and DeserializationException::tooNew().

Here is the call graph for this function:

◆ fileContent()

QByteArray AutomaticDataLoader1D::fileContent ( ) const

overridevirtual

Returns the original file content.

If not available any more (like for legacy project file import), then an empty array will be returned.

Reimplemented from AbstractDataLoader.

Definition at line 81 of file AutomaticDataLoader1D.cpp.

 {
     return m_fileContent;
 }

References m_fileContent.

Referenced by setFileContents().

◆ guessSettings()

void AbstractDataLoader::guessSettings ( )

virtualinherited

Guess appropriate settings (for example the separator in a CSV file).

Is called only once, directly after setting the file content.

Reimplemented in UserDefinedDataLoader1D, and QREDataLoader.

Definition at line 38 of file AbstractDataLoader.cpp.

38 {}

Referenced by UserDefinedDataLoader1D::guessSettings(), ImportDataUtils::Import1dData(), and SpecularDataImportWidget::onFormatSelectionChanged().

◆ importSettingsChanged

void AbstractDataLoader::importSettingsChanged ( )

signalinherited

Emitted whenever an import setting changed.

Referenced by UserDefinedDataLoader1D::UserDefinedDataLoader1D(), SpecularDataImportWidget::onFormatSelectionChanged(), and SpecularDataImportWidget::setItem().

◆ initWithDefaultImportSettings()

void AbstractDataLoader::initWithDefaultImportSettings ( )

virtualinherited

Set import settings to defaults.

Reimplemented in UserDefinedDataLoader1D, and QREDataLoader.

Definition at line 22 of file AbstractDataLoader.cpp.

22 {}

Referenced by ImportDataUtils::Import1dData(), and SpecularDataImportWidget::onFormatSelectionChanged().

◆ lineUnrelatedErrors()

QStringList AutomaticDataLoader1D::lineUnrelatedErrors ( ) const

overridevirtual

Errors not related to a particular line.

Reimplemented from AbstractDataLoader.

Definition at line 119 of file AutomaticDataLoader1D.cpp.

 {
     if (!m_error.isEmpty())
         return {m_error};
  
     return {};
 }

References m_error.

◆ name()

QString AutomaticDataLoader1D::name ( ) const

overridevirtual

The name shown in the format selection combo.

Implements AbstractDataLoader.

Definition at line 25 of file AutomaticDataLoader1D.cpp.

 {
     return "Legacy from BornAgain 1.18";
 }

◆ numErrors()

int AutomaticDataLoader1D::numErrors ( ) const

overridevirtual

Number of errors found while processing the content.

An error means that either a particular content (line) can't be used or may be suspicious (line related error), or that the whole content can't be used (e.g. only 1 line present).

Reimplemented from AbstractDataLoader.

Definition at line 114 of file AutomaticDataLoader1D.cpp.

 {
     return m_error.isEmpty() ? 0 : 1;
 }

References m_error.

◆ numLineRelatedErrors()

int AbstractDataLoader::numLineRelatedErrors ( ) const

virtualinherited

Number of errors related to a specific line.

Such an error means that a particular content (line) can't be used or may be suspicious.

Reimplemented in QREDataLoader.

Definition at line 45 of file AbstractDataLoader.cpp.

 {
     return 0;
 }

◆ persistentClassName()

QString AutomaticDataLoader1D::persistentClassName ( ) const

overridevirtual

A name which can be used for save/load purposes (which will not change ever more)

Implements AbstractDataLoader.

Definition at line 30 of file AutomaticDataLoader1D.cpp.

 {
     return "AutomaticDataLoader1D";
 }

◆ populateImportSettingsWidget()

void AbstractDataLoader::populateImportSettingsWidget ( QWidget * parent )

virtualinherited

Fills the widget on the import dialog pane.

This base class' implementation does nothing (meaning "no editable properties")

Reimplemented in UserDefinedDataLoader1D, and QREDataLoader.

Definition at line 18 of file AbstractDataLoader.cpp.

18 {}

Referenced by UserDefinedDataLoader1D::populateImportSettingsWidget(), and SpecularDataImportWidget::updatePropertiesEdits().

◆ processContents()

void AutomaticDataLoader1D::processContents ( )

overridevirtual

Process the file contents.

Can be called more than once, e.g. if the import settings have changed. Any error has to be stored in the loader (see numErrors()).

Implements AbstractDataLoader.

Definition at line 86 of file AutomaticDataLoader1D.cpp.

 {
     ASSERT(m_item != nullptr);
     ASSERT(m_item->isSpecularData());
  
     try {
         std::stringstream str(m_fileContent.constData());
         auto oData = OutputDataReadReflectometry().readOutputData(str);
  
         ImportDataInfo importInfo(std::move(*oData), Axes::Units::QSPACE);
         m_item->setImportData(std::move(importInfo));
         m_error.clear();
     } catch (std::runtime_error& ex) {
         m_item->removeNativeData();
         m_item->specularDataItem()->setOutputData(nullptr);
         m_error = QString::fromStdString(ex.what());
         if (m_error.isEmpty())
             m_error = "Unspecified error";
     }
  
     emit contentsProcessed();
 }

References ASSERT, AbstractDataLoader::contentsProcessed(), RealDataItem::isSpecularData(), m_error, m_fileContent, AbstractDataLoader::m_item, OutputDataReadReflectometry::readOutputData(), RealDataItem::removeNativeData(), RealDataItem::setImportData(), SpecularDataItem::setOutputData(), and RealDataItem::specularDataItem().

Here is the call graph for this function:

◆ realDataItem() [1/2]

RealDataItem * AbstractDataLoader::realDataItem ( )

inherited

The real data item on which the import shall work.

Definition at line 70 of file AbstractDataLoader.cpp.

 {
     return m_item;
 }

References AbstractDataLoader::m_item.

◆ realDataItem() [2/2]

const RealDataItem * AbstractDataLoader::realDataItem ( ) const

inherited

The real data item on which the import shall work.

Definition at line 75 of file AbstractDataLoader.cpp.

 {
     return m_item;
 }

References AbstractDataLoader::m_item.

◆ serialize()

QByteArray AutomaticDataLoader1D::serialize ( ) const

overridevirtual

Returns every internal setting so it can be restored completely.

Reimplemented from AbstractDataLoader.

Definition at line 42 of file AutomaticDataLoader1D.cpp.

 {
     QByteArray a;
     QDataStream s(&a, QIODevice::WriteOnly);
     s.setVersion(QDataStream::Qt_5_12);
  
     s << (quint8)1; // version
     s << m_fileContent;
     s << m_error;
  
     return a;
 }

References m_error, and m_fileContent.

Referenced by clone().

◆ setFileContents()

void AutomaticDataLoader1D::setFileContents ( const QByteArray & fileContent )

overridevirtual

Sets the file contents to be imported.

If the file was a compressed file, here already the decompressed content will be overhanded.

Implements AbstractDataLoader.

Definition at line 76 of file AutomaticDataLoader1D.cpp.

 {
     m_fileContent = fileContent;
 }

References fileContent(), and m_fileContent.

Here is the call graph for this function:

◆ setRealDataItem()

void AbstractDataLoader::setRealDataItem ( RealDataItem * item )

inherited

Define the real data item on which the import shall work.

Definition at line 65 of file AbstractDataLoader.cpp.

 {
     m_item = item;
 }

References AbstractDataLoader::m_item.

Referenced by ImportDataUtils::Import1dData(), and SpecularDataImportWidget::onFormatSelectionChanged().

Member Data Documentation

◆ m_error

QString AutomaticDataLoader1D::m_error

private

Definition at line 38 of file AutomaticDataLoader1D.h.

Referenced by deserialize(), lineUnrelatedErrors(), numErrors(), processContents(), and serialize().

◆ m_fileContent

QByteArray AutomaticDataLoader1D::m_fileContent

private

Definition at line 37 of file AutomaticDataLoader1D.h.

Referenced by deserialize(), fileContent(), processContents(), serialize(), and setFileContents().

◆ m_item

RealDataItem* AbstractDataLoader::m_item

protectedinherited

Definition at line 122 of file AbstractDataLoader.h.

Referenced by createResultModel(), processContents(), QREDataLoader::processContents(), AbstractDataLoader::realDataItem(), and AbstractDataLoader::setRealDataItem().

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

/home/www/ba/GUI/coregui/DataLoaders/AutomaticDataLoader1D.h
/home/www/ba/GUI/coregui/DataLoaders/AutomaticDataLoader1D.cpp

Signals

Public Member Functions

Protected Types

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Error

Member Function Documentation

◆ applyImportSettings()

◆ clone()

◆ contentsProcessed

◆ createResultModel()

◆ defaultImportSettings()

◆ deserialize()

◆ fileContent()

◆ guessSettings()

◆ importSettingsChanged

◆ initWithDefaultImportSettings()

◆ lineUnrelatedErrors()

◆ name()

◆ numErrors()

◆ numLineRelatedErrors()

◆ persistentClassName()

◆ populateImportSettingsWidget()

◆ processContents()

◆ realDataItem() [1/2]

◆ realDataItem() [2/2]

◆ serialize()

◆ setFileContents()

◆ setRealDataItem()

Member Data Documentation

◆ m_error

◆ m_fileContent

◆ m_item