Template implementation of file serializer using loading and storing archive implementation. More...

#include <TDeviceBasedSerializerComp.h>

Inheritance diagram for ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >:

Classes
class	ReadArchiveEx

class	WriteArchiveEx

Public Types
typedef ilog::CLoggerComponentBase	BaseClass

Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base	BaseClass
	Base class typedef for component functionality.

typedef ilog::CLoggerBase	BaseClass2
	Base class typedef for logger functionality.

Public Types inherited from ifile::IDeviceBasedPersistence
enum	OperationState { Successful , Canceled , Failed }
	Result of device-related operation. More...

enum	DeviceOperation { ReadOperation = 1 , WriteOperation = 2 }

enum	ErrorType { NoWritePermissions , NoReadPermissions , NoDeviceAccess , ReadOperationFailed , WriteOperationFailed , UnsupportedArchiveVersion }
	Possible operation errors. More...

Public Member Functions
virtual bool	IsDeviceOperationSupported (const istd::IChangeable &dataObject, const QIODevice &device, int deviceOperation) const override
	Returns `true` if object `dataObject` can be processed via defined I/O-device.

virtual ifile::IDeviceBasedPersistence::OperationState	ReadFromDevice (istd::IChangeable &data, QIODevice &device, ibase::IProgressManager *progressManagerPtr=nullptr) const override
	This function loads data `data` from the given I/O-device `device`.

virtual ifile::IDeviceBasedPersistence::OperationState	WriteToDevice (const istd::IChangeable &data, QIODevice &device, ibase::IProgressManager *progressManagerPtr=nullptr) const override
	This function writes data `data` to the given I/O-device `device`.

Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()
	Default constructor.

virtual void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Attach a message consumer for logging.

virtual ilog::IMessageConsumer *	GetLogPtr () const override
	Get the currently attached message consumer.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Member Functions
virtual const iser::IVersionInfo *	GetVersionInfo () const
	Get working version info.

bool	CheckMinimalVersion (const iser::ISerializable &object, const iser::IVersionInfo &versionInfo) const
	Check if the minimal version of some serializable object is supported by version info.

virtual void	OnReadError (const ReadArchive &archive, const istd::IChangeable &data) const
	Called if read error is occurred.

Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool	IsVerboseEnabled (int tracingLevel=0) const
	Check if verbose messages are enabled for a given tracing level.

void	SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
	Send a verbose message if enabled.

virtual void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message before sending.

virtual void	OnComponentCreated () override
	Called when component is created.

virtual void	OnComponentDestroyed () override
	Called when component is destroyed.

Protected Member Functions inherited from ilog::CLoggerBase
bool	SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send info message to log.

bool	SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send warning message to log.

bool	SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send error message to log.

bool	SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send critical message to log.

bool	SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once info message to log.

bool	SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once warning message to log.

bool	SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once error message to log.

bool	SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once critical message to log.

bool	SendUserMessage (const istd::IInformationProvider *messagePtr) const
	Send message with user object.

bool	AllowMessageOnceAgain (int id)
	Reset message lock.

virtual bool	IsLogConsumed (const istd::IInformationProvider::InformationCategory categoryPtr=NULL, const int flagsPtr=NULL) const override
	Check if any log message is consumed.

virtual bool	SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
	Send any message to log.

Additional Inherited Members
Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Detailed Description

template<class ReadArchive, class WriteArchive>
class ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >

Template implementation of file serializer using loading and storing archive implementation.

Definition at line 21 of file TDeviceBasedSerializerComp.h.

Member Typedef Documentation

◆ BaseClass

template<class ReadArchive , class WriteArchive >

typedef ilog::CLoggerComponentBase ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::BaseClass

Definition at line 24 of file TDeviceBasedSerializerComp.h.

Member Function Documentation

◆ CheckMinimalVersion()

template<class ReadArchive , class WriteArchive >

bool ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::CheckMinimalVersion	(	const iser::ISerializable &	object,
		const iser::IVersionInfo &	versionInfo
	)		const

protected

Check if the minimal version of some serializable object is supported by version info.

Definition at line 239 of file TDeviceBasedSerializerComp.h.

References iser::IVersionInfo::GetVersionIds(), and iser::IVersionInfo::GetVersionNumber().

◆ GetVersionInfo()

template<class ReadArchive , class WriteArchive >

const iser::IVersionInfo * ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::GetVersionInfo ( ) const

protectedvirtual

Get working version info.

Definition at line 231 of file TDeviceBasedSerializerComp.h.

◆ IsDeviceOperationSupported()

template<class ReadArchive , class WriteArchive >

bool ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::IsDeviceOperationSupported	(	const istd::IChangeable &	dataObject,
		const QIODevice &	device,
		int	deviceOperation
	)		const

overridevirtual

Returns true if object dataObject can be processed via defined I/O-device.

Parameters

dataObject data object should be red/written.

Implements ifile::IDeviceBasedPersistence.

Definition at line 157 of file TDeviceBasedSerializerComp.h.

◆ OnReadError()

template<class ReadArchive , class WriteArchive >

void ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::OnReadError	(	const ReadArchive &	archive,
		const istd::IChangeable &	data
	)		const

protectedvirtual

Called if read error is occurred.

Definition at line 263 of file TDeviceBasedSerializerComp.h.

◆ ReadFromDevice()

template<class ReadArchive , class WriteArchive >

ifile::IDeviceBasedPersistence::OperationState ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::ReadFromDevice	(	istd::IChangeable &	data,
		QIODevice &	device,
		ibase::IProgressManager *	progressManagerPtr = `nullptr`
	)		const

overridevirtual

This function loads data data from the given I/O-device device.

Returns: State of the reading operation.

See also: OperationState

Implements ifile::IDeviceBasedPersistence.

Definition at line 167 of file TDeviceBasedSerializerComp.h.

References iser::ISerializable::Serialize().

◆ WriteToDevice()

template<class ReadArchive , class WriteArchive >

ifile::IDeviceBasedPersistence::OperationState ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::WriteToDevice	(	const istd::IChangeable &	data,
		QIODevice &	device,
		ibase::IProgressManager *	progressManagerPtr = `nullptr`
	)		const