Simple implementation of archive writing to own ICF format binary file. More...

#include <CFileWriteArchive.h>

Inheritance diagram for ifile::CFileWriteArchive:

Collaboration diagram for ifile::CFileWriteArchive:

Classes
struct	TagStackElement

Public Types
typedef iser::CBinaryWriteArchiveBase	BaseClass

typedef CFileArchiveInfo	BaseClass2

Public Types inherited from iser::CBinaryWriteArchiveBase
typedef CWriteArchiveBase	BaseClass

Public Types inherited from iser::IArchive
enum	MessageId { MI_TAG_ERROR = 0x3f320a0 , MI_TAG_SKIPPED }

Public Member Functions
	CFileWriteArchive (const QString &filePath, const iser::IVersionInfo *versionInfoPtr=nullptr, bool supportTagSkipping=true, bool serializeHeader=true)
	Contructor.

bool	IsArchiveValid () const
	Return `true` if the archive is valid (e.g.

void	Flush ()
	Force internal stream object to flush.

virtual bool	IsTagSkippingSupported () const
	Check if skiping to the end of tag on EndTag is supported.

virtual bool	BeginTag (const iser::CArchiveTag &tag)
	Begin of archive tag.

virtual bool	EndTag (const iser::CArchiveTag &tag)
	End of archive tag.

virtual bool	ProcessData (void *data, int size)
	Process binary data block.

Public Member Functions inherited from iser::CBinaryWriteArchiveBase
virtual bool	Process (bool &value)
	Process primitive type.

virtual bool	Process (char &value)
	Process primitive type.

virtual bool	Process (quint8 &value)
	Process primitive type.

virtual bool	Process (qint8 &value)
	Process primitive type.

virtual bool	Process (quint16 &value)
	Process primitive type.

virtual bool	Process (qint16 &value)
	Process primitive type.

virtual bool	Process (quint32 &value)
	Process primitive type.

virtual bool	Process (qint32 &value)
	Process primitive type.

virtual bool	Process (quint64 &value)
	Process primitive type.

virtual bool	Process (qint64 &value)
	Process primitive type.

virtual bool	Process (float &value)
	Process primitive type.

virtual bool	Process (double &value)
	Process primitive type.

virtual bool	Process (QByteArray &value)
	Process primitive type.

virtual bool	Process (QString &value)
	Process primitive type.

Public Member Functions inherited from iser::CWriteArchiveBase
bool	IsChanging () const override
	Check if this archive processing change the object state.

const IVersionInfo &	GetVersionInfo () const override
	Get version of archived stream for specific versioning type.

bool	ProcessBits (void *dataPtr, int bitsCount, int bytesCount) override
	Process binary data block.

Public Member Functions inherited from iser::CArchiveBase
virtual bool	BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count)
	Begin of archive tag containing set of subelements of the same type.

Public Member Functions inherited from iser::IArchive
Public Member Functions inherited from ifile::CFileArchiveInfo
	CFileArchiveInfo (const QString &filePath)

virtual const QString &	GetCurrentFilePath () const

Public Member Functions inherited from ifile::IFileArchiveInfo

Additional Inherited Members
Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTag &	GetAcfRootTag ()

Protected Member Functions inherited from iser::CBinaryWriteArchiveBase
	CBinaryWriteArchiveBase (const IVersionInfo *versionInfoPtr)

Protected Member Functions inherited from iser::CWriteArchiveBase
	CWriteArchiveBase (const IVersionInfo *versionInfoPtr)
	Constructor.

bool	SerializeIcfHeader ()
	Serialize standard header.

Protected Member Functions inherited from iser::CArchiveBase
	CArchiveBase ()

Protected Member Functions inherited from istd::ILogger
virtual void	DecorateMessage (IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
	Decorate message parts before outputting.

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

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

Protected Attributes inherited from ifile::CFileArchiveInfo
QString	m_filePath

Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag	s_acfRootTag

Detailed Description

Simple implementation of archive writing to own ICF format binary file.

This imlementation is very fast and efficient and should be used if any standarized file format is needed.

Definition at line 28 of file CFileWriteArchive.h.

Member Typedef Documentation

◆ BaseClass

iser::CBinaryWriteArchiveBase ifile::CFileWriteArchive::BaseClass

Definition at line 33 of file CFileWriteArchive.h.

◆ BaseClass2

CFileArchiveInfo ifile::CFileWriteArchive::BaseClass2

Definition at line 34 of file CFileWriteArchive.h.

Constructor & Destructor Documentation

◆ CFileWriteArchive()

ifile::CFileWriteArchive::CFileWriteArchive	(	const QString &	filePath,
		const iser::IVersionInfo *	versionInfoPtr = nullptr,
		bool	supportTagSkipping = true,
		bool	serializeHeader = true )

Contructor.

Parameters

filePath	name of file.
supportTagSkipping	if it is true skipping of tags on EndTag is supported. Please note that supporting of tag skipping store additional data in file and it is not compatible with files created without tag skipping.

See also: EndTag and IsTagSkippingSupported.

Parameters

serializeHeader if it is true (default) archive header will be serialized.

Member Function Documentation

◆ BeginTag()

virtual bool ifile::CFileWriteArchive::BeginTag ( const iser::CArchiveTag & tag )

virtual

Begin of archive tag.

Parameters

tag	tag object.
useTagSkipping	flag signalling that support of tag skipping should be enabled.

Reimplemented from iser::CBinaryWriteArchiveBase.

◆ EndTag()

virtual bool ifile::CFileWriteArchive::EndTag ( const iser::CArchiveTag & tag )

virtual

End of archive tag.

This method should be allways called after BeginTag is successfull called. If skipping of tag contains is supported, this will skip to the end of tag while archive reading. Otherwise you have to read contains of archive completely.

See also: IsTagSkippingSupported.

Reimplemented from iser::CBinaryWriteArchiveBase.

◆ Flush()

void ifile::CFileWriteArchive::Flush ( )

Force internal stream object to flush.

◆ IsArchiveValid()

bool ifile::CFileWriteArchive::IsArchiveValid ( ) const

inline

Return true if the archive is valid (e.g.

the file medium can be accessed)

Definition at line 89 of file CFileWriteArchive.h.

◆ IsTagSkippingSupported()

virtual bool ifile::CFileWriteArchive::IsTagSkippingSupported ( ) const

virtual

Check if skiping to the end of tag on EndTag is supported.

See also: EndTag.

Reimplemented from iser::CArchiveBase.

◆ ProcessData()

virtual bool ifile::CFileWriteArchive::ProcessData	(	void *	dataPtr,
		int	size )

virtual

Process binary data block.

Parameters

dataPtr	pointer to memory block.
size	size of memory block in bytes.

Implements iser::IArchive.

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

ifile/CFileWriteArchive.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Constructor & Destructor Documentation

◆ CFileWriteArchive()

Member Function Documentation

◆ BeginTag()

◆ EndTag()

◆ Flush()

◆ IsArchiveValid()

◆ IsTagSkippingSupported()

◆ ProcessData()