iser::CBitMemoryReadArchive Class Reference

This class provides bitwise access to the byte data. More...

#include <CBitMemoryReadArchive.h>

Inheritance diagram for iser::CBitMemoryReadArchive:

Public Types
typedef CMemoryReadArchive	BaseClass
Public Types inherited from iser::CMemoryReadArchive
typedef CBinaryReadArchiveBase	BaseClass
Public Types inherited from iser::CBinaryReadArchiveBase
enum	MessageId { MI_STRING_TOO_LONG = 0x3f320b0 }
typedef CReadArchiveBase	BaseClass
Public Types inherited from iser::IArchive
enum	MessageId { MI_TAG_ERROR = 0x3f320a0 , MI_TAG_SKIPPED }

Public Member Functions
	CBitMemoryReadArchive (const QVector< quint8 > &data, bool serializeHeader=true)
	Constructs a bit stream from a vector of bytes.
	CBitMemoryReadArchive (const void *bufferPtr, int bufferSize, bool serializeHeader=true)
	CBitMemoryReadArchive (const CMemoryWriteArchive &writeArchive, bool serializeHeader=true)
virtual quint32	ReadValue (int bits)
	Gets the value of the next bits in the stream.
virtual bool	ProcessData (void *data, int size) override
	Process binary data block.
virtual bool	ProcessBits (void *dataPtr, int bitsCount, int bytesCount) override
	Process binary data block.
virtual void	ResetPosition () override
	Seeks internal cursor to the begin of data.
virtual bool	IsValid () const override
	Returns true if the archive is in valid state and internal position cursor has not reached end of archive data.
Public Member Functions inherited from iser::CMemoryReadArchive
	CMemoryReadArchive (const void *bufferPtr, int bufferSize, bool serializeHeader=true)
	CMemoryReadArchive (const CMemoryWriteArchive &writeArchive, bool serializeHeader=true)
Public Member Functions inherited from iser::CBinaryReadArchiveBase
virtual bool	BeginTag (const CArchiveTag &tag) override
	Begins a tagged section in the archive.
virtual bool	EndTag (const CArchiveTag &tag) override
	Ends a tagged section in the archive.
virtual bool	Process (bool &value) override
	Processes (reads or writes) a boolean value.
virtual bool	Process (char &value) override
	Process primitive type.
virtual bool	Process (quint8 &value) override
	Process primitive type.
virtual bool	Process (qint8 &value) override
	Process primitive type.
virtual bool	Process (quint16 &value) override
	Process primitive type.
virtual bool	Process (qint16 &value) override
	Process primitive type.
virtual bool	Process (quint32 &value) override
	Process primitive type.
virtual bool	Process (qint32 &value) override
	Process primitive type.
virtual bool	Process (quint64 &value) override
	Process primitive type.
virtual bool	Process (qint64 &value) override
	Process primitive type.
virtual bool	Process (float &value) override
	Process primitive type.
virtual bool	Process (double &value) override
	Process primitive type.
virtual bool	Process (QByteArray &value) override
	Process primitive type.
virtual bool	Process (QString &value) override
	Process primitive type.
Public Member Functions inherited from iser::CReadArchiveBase
virtual bool	IsStoring () const override
	Checks if this archive is in storing (writing) or loading (reading) mode.
virtual const IVersionInfo &	GetVersionInfo () const override
	Gets version information for the archived stream.
Public Member Functions inherited from iser::CArchiveBase
virtual bool	IsTagSkippingSupported () const override
	Checks if skipping to the end of a tag on EndTag() is supported.
virtual bool	BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count) override
	Begins a tagged section containing multiple elements of the same type.
Public Member Functions inherited from iser::IArchive
template<typename Primitive >
bool	TagAndProcess (const CArchiveTag &tag, Primitive &value)
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Attributes
int	m_bitPosition
Protected Attributes inherited from iser::CMemoryReadArchive
const quint8 *	m_bufferPtr
	Pointer to the memory buffer used for reading data.
int	m_bufferSize
	Size of the memory buffer used for reading data.
int	m_readPosition
	Current position in the buffer from which data will be read next.
bool	m_isValid
	Indicates whether the archive is in valid state.
int	m_startPosition
	Start position of actual data in the buffer (after header, if any)

Additional Inherited Members
Static Public Member Functions inherited from iser::CMemoryReadArchive
static bool	CloneObjectByArchive (const ISerializable &source, ISerializable &result)
	Clone serializable objects using iser::CMemoryWriteArchive and iser::CMemoryReadArchive archives.
Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTag &	GetAcfRootTag ()
Protected Member Functions inherited from iser::CMemoryReadArchive
virtual int	GetMaxStringLength () const override
	Get maximal allowed string size.
Protected Member Functions inherited from iser::CReadArchiveBase
bool	SerializeAcfHeader ()
	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=NULL, const int *flagsPtr=NULL) 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.
Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag	s_acfRootTag

Detailed Description

This class provides bitwise access to the byte data.

Definition at line 21 of file CBitMemoryReadArchive.h.

Member Typedef Documentation

BaseClass

typedef CMemoryReadArchive iser::CBitMemoryReadArchive::BaseClass

Definition at line 24 of file CBitMemoryReadArchive.h.

Constructor & Destructor Documentation

CBitMemoryReadArchive() [1/3]

iser::CBitMemoryReadArchive::CBitMemoryReadArchive	(	const QVector< quint8 > &	data,
		bool	serializeHeader = true
	)

Constructs a bit stream from a vector of bytes.

CBitMemoryReadArchive() [2/3]

iser::CBitMemoryReadArchive::CBitMemoryReadArchive	(	const void *	bufferPtr,
		int	bufferSize,
		bool	serializeHeader = true
	)

CBitMemoryReadArchive() [3/3]

iser::CBitMemoryReadArchive::CBitMemoryReadArchive	(	const CMemoryWriteArchive &	writeArchive,
		bool	serializeHeader = true
	)

Member Function Documentation

IsValid()

virtual bool iser::CBitMemoryReadArchive::IsValid ( ) const

overridevirtual

Returns true if the archive is in valid state and internal position cursor has not reached end of archive data.

Reimplemented from iser::CMemoryReadArchive.

ProcessBits()

virtual bool iser::CBitMemoryReadArchive::ProcessBits ( void *  dataPtr, int  bitsCount, int  bytesCount  )

overridevirtual

Process binary data block.

Parameters

dataPtr	pointer to memory block.
bitsCount	number of bits.
bytesCount	size of memory block in bytes.

Reimplemented from iser::CReadArchiveBase.

ProcessData()

virtual bool iser::CBitMemoryReadArchive::ProcessData ( void *  dataPtr, int  size  )

overridevirtual

Process binary data block.

Parameters

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

Reimplemented from iser::CMemoryReadArchive.

ReadValue()

virtual quint32 iser::CBitMemoryReadArchive::ReadValue ( int  bits )

virtual

Gets the value of the next bits in the stream.

ResetPosition()

virtual void iser::CBitMemoryReadArchive::ResetPosition ( )

overridevirtual

Seeks internal cursor to the begin of data.

Reimplemented from iser::CMemoryReadArchive.

Member Data Documentation

m_bitPosition

int iser::CBitMemoryReadArchive::m_bitPosition

protected

Definition at line 54 of file CBitMemoryReadArchive.h.

---

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

• Acf/Include/iser/CBitMemoryReadArchive.h