SaveLoadInterface.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Support/IO/SaveLoadInterface.h
//! @brief     Defines save/load interface.
//!
//! @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_SUPPORT_IO_SAVELOADINTERFACE_H
#define BORNAGAIN_GUI_SUPPORT_IO_SAVELOADINTERFACE_H
 
#include <QDateTime>
#include <QString>
 
//! Abstract base class to handle non-XML data save and load.
 
//! Inherited (mix-in) by DataItem
 
class SaveLoadInterface {
public:
    virtual ~SaveLoadInterface() = default;
 
    //! Loads non-XML data from _projectDir_ and returns success flag.
    virtual bool loadData(const QString& projectDir) = 0;
 
    //! Saves non-XML data in _projectDir_ and returns success flag.
    virtual bool saveData(const QString& projectDir) = 0;
 
    //! Checks if object owns non-XML data
    virtual bool containsNonXMLData() const = 0;
 
    //! Indicates last modification timepoint.
    virtual QDateTime lastModified() const = 0;
 
    //! Reports file name to save/load non-XML data.
    virtual QString fileName() const = 0;
 
    //! Reports file name to save/load non-XML data with directory name attached.
    QString fileName(const QString& projectDir) const;
};
 
#endif // BORNAGAIN_GUI_SUPPORT_IO_SAVELOADINTERFACE_H