OutputDataIOService Class Reference

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

Inheritance diagram for OutputDataIOService:

Collaboration diagram for OutputDataIOService:

Public Member Functions
	OutputDataIOService (ApplicationModels *models, QObject *parent=nullptr)
	OutputDataIOService (QObject *parent=nullptr)
void	load (const QString &projectDir, MessageService *messageService=nullptr)
QVector< SaveLoadInterface * >	nonXMLItems () const
	Returns all non-XML items available for save/load. More...
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. More...

Private Attributes
ApplicationModels *	m_applicationModels
OutputDataIOHistory	m_history

Detailed 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 OutputDataIOService.h.

Constructor & Destructor Documentation

OutputDataIOService() [1/2]

OutputDataIOService::OutputDataIOService ( QObject *  parent = nullptr )

explicit

Definition at line 28 of file OutputDataIOService.cpp.

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

OutputDataIOService() [2/2]

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

explicit

Definition at line 34 of file OutputDataIOService.cpp.

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

References setApplicationModels().

Here is the call graph for this function:

Member Function Documentation

cleanOldFiles()

void OutputDataIOService::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 119 of file OutputDataIOService.cpp.

{
    QStringList to_remove = ProjectUtils::substract(oldSaves, newSaves);
    ProjectUtils::removeFiles(projectDir, to_remove);
}

References ProjectUtils::projectDir(), ProjectUtils::removeFiles(), and ProjectUtils::substract().

Referenced by save().

Here is the call graph for this function:

load()

void OutputDataIOService::load	(	const QString &	projectDir,
		MessageService *	messageService = nullptr
	)

Definition at line 68 of file OutputDataIOService.cpp.

{
    OutputDataDirHistory newHistory;
 
    for (auto item : nonXMLItems()) {
        try {
            item->load(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("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("Failed");
            }
            if (messageService)
                messageService->send_warning(this, QString(ex.what()));
            else
                throw ex;
        }
    }
    m_history.setHistory(projectDir, newHistory);
}

References m_history, OutputDataDirHistory::markAsSaved(), nonXMLItems(), ProjectUtils::projectDir(), MessageService::send_warning(), and OutputDataIOHistory::setHistory().

Referenced by ProjectDocument::load().

Here is the call graph for this function:

nonXMLItems()

QVector< SaveLoadInterface * > OutputDataIOService::nonXMLItems

(

)

const

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

Definition at line 102 of file OutputDataIOService.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(), load(), and save().

Here is the call graph for this function:

save()

void OutputDataIOService::save

(

const QString &

projectDir

)

Definition at line 46 of file OutputDataIOService.cpp.

{
    if (!m_history.hasHistory(projectDir))
        m_history.setHistory(projectDir, OutputDataDirHistory());
 
    OutputDataDirHistory newHistory;
 
    for (auto item : nonXMLItems()) {
        if (m_history.wasModifiedSinceLastSave(projectDir, item))
            item->save(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(), OutputDataIOHistory::hasHistory(), m_history, OutputDataDirHistory::markAsSaved(), nonXMLItems(), ProjectUtils::projectDir(), OutputDataDirHistory::savedFileNames(), OutputDataIOHistory::savedFileNames(), OutputDataIOHistory::setHistory(), and OutputDataIOHistory::wasModifiedSinceLastSave().

Referenced by ProjectDocument::save_project_data().

Here is the call graph for this function:

setApplicationModels()

void OutputDataIOService::setApplicationModels

(

ApplicationModels *

models

)

Definition at line 41 of file OutputDataIOService.cpp.

{
    m_applicationModels = models;
}

References m_applicationModels.

Referenced by OutputDataIOService(), and ProjectDocument::setApplicationModels().

Member Data Documentation

m_applicationModels

ApplicationModels* OutputDataIOService::m_applicationModels

private

Definition at line 49 of file OutputDataIOService.h.

Referenced by nonXMLItems(), and setApplicationModels().

m_history

OutputDataIOHistory OutputDataIOService::m_history

private

Definition at line 48 of file OutputDataIOService.h.

Referenced by load(), and save().

---

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

• /home/www/ba/GUI/coregui/mainwindow/OutputDataIOService.h
• /home/www/ba/GUI/coregui/mainwindow/OutputDataIOService.cpp