IOHistory.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Support/IO/IOHistory.cpp
//! @brief     Defines DatafieldIOHistory classes
//!
//! @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)
//
//  ************************************************************************************************
 
#include "GUI/Support/IO/IOHistory.h"
#include "Base/Util/Assert.h"
#include "GUI/Support/IO/SaveLoadInterface.h"
#include "GUI/Util/Error.h"
 
//! Static method to create info for just saved item.
 
DatafieldSaveInfo DatafieldSaveInfo::createSaved(const SaveLoadInterface* item)
{
    ASSERT(item);
 
    DatafieldSaveInfo result;
    result.m_data = item;
    result.m_file_name = item->fileName();
    result.m_last_saved = QDateTime::currentDateTime();
    return result;
}
 
bool DatafieldSaveInfo::wasModifiedSinceLastSave() const
{
    return wasSavedBefore(m_data->lastModified());
}
 
//! Returns true if IntensityDataItem was saved before given time.
 
bool DatafieldSaveInfo::wasSavedBefore(const QDateTime& dtime) const
{
    // positive number means that m_last_saved is older than dtime
    return m_last_saved.msecsTo(dtime) > 0;
}
 
//-----------------------------------------------------------------------------
 
void DatafieldDirHistory::markAsSaved(const SaveLoadInterface* item)
{
    if (contains(item))
        throw Error("DatafieldDirHistory::markAsSaved() -> Error. "
                    "Already existing item.");
    // Don't create any history info for empty items
    if (item->containsNonXMLData())
        m_history.push_back(DatafieldSaveInfo::createSaved(item));
}
 
bool DatafieldDirHistory::wasModifiedSinceLastSave(const SaveLoadInterface* item)
{
    // non existing item is treated as modified since last save
    return contains(item) ? itemInfo(item).wasModifiedSinceLastSave() : true;
}
 
bool DatafieldDirHistory::contains(const SaveLoadInterface* item)
{
    for (auto& info : m_history)
        if (info.item() == item)
            return true;
 
    return false;
}
 
//! Returns list of file names used to save all items in a history.
 
QStringList DatafieldDirHistory::savedFileNames() const
{
    QStringList result;
 
    for (const auto& info : m_history)
        result.append(info.fileName());
 
    return result;
}
 
DatafieldSaveInfo DatafieldDirHistory::itemInfo(const SaveLoadInterface* item) const
{
    for (const auto& info : m_history) {
        if (info.item() == item)
            return info;
    }
 
    throw Error("DatafieldDirHistory::itemInfo() -> Error. No info exists.");
}
 
//-----------------------------------------------------------------------------
 
bool DatafieldIOHistory::hasHistory(const QString& dirname) const
{
    return m_dir_history.find(dirname) != m_dir_history.end();
}
 
bool DatafieldIOHistory::wasModifiedSinceLastSave(const QString& dirname,
                                                  const SaveLoadInterface* item)
{
    if (!hasHistory(dirname))
        throw Error("DatafieldIOHistory::wasModifiedSinceLastSave() -> Error. "
                    "No info for directory '"
                    + dirname + "'.");
    return m_dir_history[dirname].wasModifiedSinceLastSave(item);
}
 
//! Sets history for given directory. Previous history will be rewritten.
 
void DatafieldIOHistory::setHistory(const QString& dirname, const DatafieldDirHistory& history)
{
    ASSERT(!dirname.isEmpty());
 
    m_dir_history[dirname] = history;
}
 
QStringList DatafieldIOHistory::savedFileNames(const QString& dirname) const
{
    if (!hasHistory(dirname))
        throw Error("DatafieldIOHistory::savedFileNames() -> Error. "
                    "No info for directory '"
                    + dirname + "'.");
 
    return m_dir_history[dirname].savedFileNames();
}