DatafieldIOService Class Reference

Description

Provide read/write of heavy data files in a separate thread.

Listens all models and keep tracks of changes in items. Provides logic to not to re-save already saved data.

Definition at line 30 of file IOService.h.

Inheritance diagram for DatafieldIOService:

Collaboration diagram for DatafieldIOService:

Public Member Functions
	DatafieldIOService (ApplicationModels *models, QObject *parent=nullptr)
	DatafieldIOService (QObject *parent=nullptr)
QVector< SaveLoadInterface * >	dataInterfaces () const
	Returns all non-XML items available for save/load. More...
void	loadDataFiles (const QString &projectDir, MessageService *messageService=nullptr)
void	save (const QString &projectDir)
void	setApplicationModels (ApplicationModels *models)

Private Member Functions
void	cleanOldFiles (const QString &projectDir, const QStringList &oldSaves, const QStringList &newSaves)
	Clean old saved files. All files in oldSaves list, which are not in newSaves list, will be removed. More...

Private Attributes
ApplicationModels *	m_applicationModels
DatafieldIOHistory	m_history

Constructor & Destructor Documentation

DatafieldIOService() [1/2]

DatafieldIOService::DatafieldIOService ( QObject *  parent = nullptr )

explicit

Definition at line 35 of file IOService.cpp.

    : QObject(parent)
    , m_applicationModels(nullptr)
{
    setObjectName("DatafieldIOService");
}

DatafieldIOService() [2/2]

DatafieldIOService::DatafieldIOService ( ApplicationModels *  models, QObject *  parent = nullptr  )

explicit

Definition at line 42 of file IOService.cpp.

    : QObject(parent)
    , m_applicationModels(nullptr)
{
    setObjectName("DatafieldIOService");
    setApplicationModels(models);
}

References setApplicationModels().

Here is the call graph for this function:

Member Function Documentation

cleanOldFiles()

void DatafieldIOService::cleanOldFiles ( const QString &  projectDir, const QStringList &  oldSaves, const QStringList &  newSaves  )

private

Clean old saved files. All files in oldSaves list, which are not in newSaves list, will be removed.

Definition at line 126 of file IOService.cpp.

{
    const auto toRemove = oldSaves.toSet().subtract(newSaves.toSet());
    for (const auto& name : toRemove)
        QFile::remove(projectDir + "/" + name);
}

References GUI::RealSpace::Particles::name(), and GUI::Project::Utils::projectDir().

Referenced by save().

Here is the call graph for this function:

dataInterfaces()

QVector< SaveLoadInterface * > DatafieldIOService::dataInterfaces

(

)

const

Returns all non-XML items available for save/load.

Definition at line 109 of file IOService.cpp.

{
    QVector<SaveLoadInterface*> result;
 
    if (!m_applicationModels)
        return result;
 
    for (auto* item : m_applicationModels->nonXMLItems())
        if (auto* non_xml_item = dynamic_cast<SaveLoadInterface*>(item))
            result.push_back(non_xml_item);
 
    return result;
}

References m_applicationModels, and ApplicationModels::nonXMLItems().

Referenced by ProjectDocument::hasData(), loadDataFiles(), and save().

Here is the call graph for this function:

loadDataFiles()

void DatafieldIOService::loadDataFiles	(	const QString &	projectDir,
		MessageService *	messageService = nullptr
	)

Definition at line 77 of file IOService.cpp.

{
    DatafieldDirHistory newHistory;
 
    for (SaveLoadInterface* item : dataInterfaces()) {
        try {
            item->loadData(projectDir);
            newHistory.markAsSaved(item);
            // handling crash of GUI during job run and non-existing file
            if (auto* jobItem = parentJobItem(item)) {
                if (jobItem->isRunning()) {
                    jobItem->setComments("Possible GUI crash while job was running");
                    jobItem->setStatus(JobStatus::Failed);
                }
            }
        } catch (const std::exception& ex) {
            if (auto* jobItem = parentJobItem(item)) {
                // Handling corrupted file on disk
                jobItem->setComments(
                    QString("Load of the data from disk failed with '%1'").arg(QString(ex.what())));
                jobItem->setStatus(JobStatus::Failed);
            }
            if (!messageService)
                throw ex;
            messageService->addWarning(this, QString(ex.what()));
        }
    }
    m_history.setHistory(projectDir, newHistory);
}

References MessageService::addWarning(), dataInterfaces(), Failed, m_history, DatafieldDirHistory::markAsSaved(), GUI::Project::Utils::projectDir(), and DatafieldIOHistory::setHistory().

Referenced by ProjectDocument::loadProjectFile().

Here is the call graph for this function:

save()

void DatafieldIOService::save

(

const QString &

projectDir

)

Definition at line 55 of file IOService.cpp.

{
    if (!m_history.hasHistory(projectDir))
        m_history.setHistory(projectDir, DatafieldDirHistory());
 
    DatafieldDirHistory newHistory;
 
    for (SaveLoadInterface* item : dataInterfaces()) {
        if (m_history.wasModifiedSinceLastSave(projectDir, item))
            item->saveData(projectDir);
        newHistory.markAsSaved(item);
    }
 
    // dealing with files
    QStringList oldFiles = m_history.savedFileNames(projectDir);
    QStringList newFiles = newHistory.savedFileNames();
    cleanOldFiles(projectDir, oldFiles, newFiles);
 
    // if oldHistory contained some deleted items, that info will be dropped here
    m_history.setHistory(projectDir, newHistory);
}

References cleanOldFiles(), dataInterfaces(), DatafieldIOHistory::hasHistory(), m_history, DatafieldDirHistory::markAsSaved(), GUI::Project::Utils::projectDir(), DatafieldDirHistory::savedFileNames(), DatafieldIOHistory::savedFileNames(), DatafieldIOHistory::setHistory(), and DatafieldIOHistory::wasModifiedSinceLastSave().

Referenced by ProjectDocument::saveProjectData().

Here is the call graph for this function:

setApplicationModels()

void DatafieldIOService::setApplicationModels

(

ApplicationModels *

models

)

Definition at line 50 of file IOService.cpp.

{
    m_applicationModels = models;
}

References m_applicationModels.

Referenced by DatafieldIOService(), and ProjectDocument::ProjectDocument().

Member Data Documentation

m_applicationModels

ApplicationModels* DatafieldIOService::m_applicationModels

private

Definition at line 49 of file IOService.h.

Referenced by dataInterfaces(), and setApplicationModels().

m_history

DatafieldIOHistory DatafieldIOService::m_history

private

Definition at line 48 of file IOService.h.

Referenced by loadDataFiles(), and save().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Project/IOService.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Project/IOService.cpp