Base implementation of file serializer. More...

#include <CFileSerializerCompBase.h>

Inheritance diagram for ifile::CFileSerializerCompBase:

Public Types
typedef ilog::TLoggerCompWrap< CFileTypeInfoComp >	BaseClass

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

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

Public Types inherited from ifile::IFilePersistence
enum	OperationState { OS_OK , OS_CANCELED , OS_FAILED }
	Result of operation. More...

enum	ErrorType { ET_NO_WRITE_PERMISSIONS , ET_NO_READ_PERMISSIONS , ET_FILE_NOT_EXIST }
	Possible file I/O errors. More...

enum	MessageId { MI_BAD_OBJECT_TYPE = 0xabf0 , MI_CANNOT_LOAD , MI_CANNOT_SAVE , MI_BAD_EXTENSION , MI_FILE_NOT_EXIST , MI_UNSUPPORTED_VERSION }
	List of possible message IDs used in context of this interface. More...

Public Types inherited from ifile::IFileTypeInfo
enum	QueryFlags { QF_LOAD = 1 << 0 , QF_SAVE = 1 << 1 , QF_FILE = 1 << 2 , QF_DIRECTORY = 1 << 3 , QF_ANONYMOUS = 1 << 4 }
	Describe detailed options of query. More...

Public Member Functions
virtual bool	IsOperationSupported (const istd::IChangeable dataObjectPtr, const QString filePathPtr=nullptr, int flags=-1, bool beQuiet=true) const override
	Returns `true` if object `dataObject` can be loaded/saved.

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 ()

Public Member Functions inherited from ifile::IFilePersistence
virtual OperationState	LoadFromFile (istd::IChangeable &data, const QString &filePath=QString(), ibase::IProgressManager *progressManagerPtr=NULL) const =0
	This function loads data `data` from file `filePath`.

virtual OperationState	SaveToFile (const istd::IChangeable &data, const QString &filePath=QString(), ibase::IProgressManager *progressManagerPtr=NULL) const =0
	This function saves data `data` to file `filePath`.

Public Member Functions inherited from ifile::IFileTypeInfo
virtual bool	GetFileExtensions (QStringList &result, const istd::IChangeable *dataObjectPtr=NULL, int flags=-1, bool doAppend=false) const =0
	Get file extensions supported by this loader.

virtual QString	GetTypeDescription (const QString *extensionPtr=NULL) const =0
	Get description of object type associated with single extension.

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.

bool	CheckInputFile (const QString filePath, bool beQuiet=true) const
	Check if input file is OK.

bool	CheckOutputFile (const QString filePath, bool beQuiet=true) const
	Check if output file is OK.

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

Protected Member Functions inherited from ilog::TLoggerCompWrap< CFileTypeInfoComp >
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	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

Base implementation of file serializer.

Serializer allows to load and save objects implementing iser::ISerializable interface.

Definition at line 26 of file CFileSerializerCompBase.h.

Member Typedef Documentation

◆ BaseClass

typedef ilog::TLoggerCompWrap<CFileTypeInfoComp> ifile::CFileSerializerCompBase::BaseClass

Definition at line 31 of file CFileSerializerCompBase.h.

Member Function Documentation

◆ CheckInputFile()

bool ifile::CFileSerializerCompBase::CheckInputFile	(	const QString	filePath,
		bool	beQuiet = `true`
	)		const

protected

Check if input file is OK.

◆ CheckMinimalVersion()

bool ifile::CFileSerializerCompBase::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.

◆ CheckOutputFile()

bool ifile::CFileSerializerCompBase::CheckOutputFile	(	const QString	filePath,
		bool	beQuiet = `true`
	)		const

protected

Check if output file is OK.

◆ GetVersionInfo()

virtual const iser::IVersionInfo * ifile::CFileSerializerCompBase::GetVersionInfo ( ) const

protectedvirtual

Get working version info.

◆ IsOperationSupported()

virtual bool ifile::CFileSerializerCompBase::IsOperationSupported	(	const istd::IChangeable *	dataObjectPtr,
		const QString *	filePathPtr = `nullptr`,
		int	flags = `-1`,
		bool	beQuiet = `true`
	)		const

overridevirtual

Returns true if object dataObject can be loaded/saved.

Parameters

dataObjectPtr	optional pointer to data object should be loaded/stored. It can be NULL if any object is meant.
filePathPtr	optional pointer to file should be loaded/stored. It can be NULL if any file is meant. If it points at empty string, anonymous loading is mean.
flags	combination of flags defined in `QueryFlags` and `ifile::IFileTypeInfo::QueryFlags`.
beQuiet	if true, no user message output is allowed.

Implements ifile::IFilePersistence.

◆ OnComponentCreated()

virtual void ifile::CFileSerializerCompBase::OnComponentCreated ( )

overrideprotectedvirtual

Called when component is created.

Automatically connects the log consumer from the "Log" reference.

Note: Override to add initialization, but always call base class:
virtual void OnComponentCreated() override {

// Custom initialization

BaseClass::OnComponentCreated();

}

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

ilog::TLoggerCompWrap< CFileTypeInfoComp >::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.
Definition TLoggerCompWrap.h:330

Reimplemented from ilog::TLoggerCompWrap< CFileTypeInfoComp >.

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

Acf/Include/ifile/CFileSerializerCompBase.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ CheckInputFile()

◆ CheckMinimalVersion()

◆ CheckOutputFile()

◆ GetVersionInfo()

◆ IsOperationSupported()

◆ OnComponentCreated()