IDeviceBasedPersistence.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QIODevice>
 
// ACF includes
#include <istd/IPolymorphic.h>
 
 
namespace ibase
{
       class IProgressManager;
}
 
namespace istd
{
       class IChangeable;
}
 
 
namespace ifile
{
 
 
class IDeviceBasedPersistence: virtual public istd::IPolymorphic
{
public:
       enum OperationState
       {
              Successful,
 
              Canceled,
 
              Failed
       };
 
       enum DeviceOperation
       {
              ReadOperation = 1,
              WriteOperation = 2
       };
 
       enum ErrorType
       {
              NoWritePermissions,
 
              NoReadPermissions,
 
              NoDeviceAccess,
 
              ReadOperationFailed,
 
              WriteOperationFailed,
 
              UnsupportedArchiveVersion
       };
 
       virtual bool IsDeviceOperationSupported(const istd::IChangeable& dataObject, const QIODevice& device, int deviceOperation) const = 0;
 
       virtual OperationState ReadFromDevice(
                            istd::IChangeable& data,
                            QIODevice& device,
                            ibase::IProgressManager* progressManagerPtr = nullptr) const = 0;
 
       virtual OperationState WriteToDevice(
                            const istd::IChangeable& data,
                            QIODevice& device,
                            ibase::IProgressManager* progressManagerPtr = nullptr) const = 0;
};
 
 
} // namespace ifile