Classes | Public Types | Public Member Functions | List of all members
ifile::CFileWriteArchive Class Reference

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

#include <CFileWriteArchive.h>

Inheritance diagram for ifile::CFileWriteArchive:
iser::CBinaryWriteArchiveBase ifile::CFileArchiveInfo iser::CWriteArchiveBase ifile::IFileArchiveInfo iser::CArchiveBase istd::IPolymorphic iser::IArchive istd::ILogger istd::IPolymorphic istd::IPolymorphic

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=NULL, bool supportTagSkipping=true, bool serializeHeader=true)
 Contructor. More...
 
bool IsArchiveValid () const
 Return true if the archive is valid (e.g. More...
 
void Flush ()
 Force internal stream object to flush. More...
 
virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported. More...
 
virtual bool BeginTag (const iser::CArchiveTag &tag)
 Begin of archive tag. More...
 
virtual bool EndTag (const iser::CArchiveTag &tag)
 End of archive tag. More...
 
virtual bool ProcessData (void *data, int size)
 Process binary data block. More...
 
- Public Member Functions inherited from iser::CBinaryWriteArchiveBase
virtual bool Process (bool &value)
 Process primitive type. More...
 
virtual bool Process (char &value)
 Process primitive type. More...
 
virtual bool Process (quint8 &value)
 Process primitive type. More...
 
virtual bool Process (qint8 &value)
 Process primitive type. More...
 
virtual bool Process (quint16 &value)
 Process primitive type. More...
 
virtual bool Process (qint16 &value)
 Process primitive type. More...
 
virtual bool Process (quint32 &value)
 Process primitive type. More...
 
virtual bool Process (qint32 &value)
 Process primitive type. More...
 
virtual bool Process (quint64 &value)
 Process primitive type. More...
 
virtual bool Process (qint64 &value)
 Process primitive type. More...
 
virtual bool Process (float &value)
 Process primitive type. More...
 
virtual bool Process (double &value)
 Process primitive type. More...
 
virtual bool Process (QByteArray &value)
 Process primitive type. More...
 
virtual bool Process (QString &value)
 Process primitive type. More...
 
- Public Member Functions inherited from iser::CWriteArchiveBase
virtual bool IsStoring () const
 Check if this archive is loading or storing. More...
 
virtual const IVersionInfoGetVersionInfo () const
 Get version of archived stream for specific versioning type. More...
 
virtual bool ProcessBits (void *dataPtr, int bitsCount, int bytesCount)
 Process binary data block. More...
 
- 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. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from ifile::CFileArchiveInfo
 CFileArchiveInfo (const QString &filePath)
 
virtual const QString & GetCurrentFilePath () const
 

Additional Inherited Members

- Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTagGetAcfRootTag ()
 
- Protected Member Functions inherited from iser::CBinaryWriteArchiveBase
 CBinaryWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 
- Protected Member Functions inherited from iser::CWriteArchiveBase
 CWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 Constructor. More...
 
bool SerializeAcfHeader ()
 Serialize standard header. More...
 
- 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. More...
 
virtual bool IsLogConsumed (const IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const
 Check if any log message is consumed. More...
 
virtual bool SendLogMessage (IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
 Send any message to log. More...
 
- 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 ACF format binary file.

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

Definition at line 24 of file CFileWriteArchive.h.

Member Typedef Documentation

Definition at line 29 of file CFileWriteArchive.h.

Definition at line 30 of file CFileWriteArchive.h.

Constructor & Destructor Documentation

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

Contructor.

Parameters
filePathname of file.
supportTagSkippingif 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
serializeHeaderif it is true (default) archive header will be serialized.

Member Function Documentation

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

Begin of archive tag.

Parameters
tagtag object.
useTagSkippingflag signalling that support of tag skipping should be enabled.

Reimplemented from iser::CBinaryWriteArchiveBase.

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.

void ifile::CFileWriteArchive::Flush ( )

Force internal stream object to flush.

bool ifile::CFileWriteArchive::IsArchiveValid ( ) const
inline

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

the file medium can be accessed)

Definition at line 85 of file CFileWriteArchive.h.

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.

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

Process binary data block.

Parameters
dataPtrpointer to memory block.
sizesize of memory block in bytes.

Implements iser::IArchive.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy