Process tag used to group data in archive stream. More...

#include <CArchiveTag.h>

Collaboration diagram for iser::CArchiveTag:

Public Types
enum	TagType { TT_UNKNOWN , TT_GROUP , TT_MULTIPLE , TT_LEAF , TT_WEAK }
	Describe type of tag. More...

Public Member Functions
	CArchiveTag ()

	CArchiveTag (const QByteArray &id, const QByteArray &comment, TagType tagType=TT_UNKNOWN, const CArchiveTag *parentPtr=nullptr, bool isTagSkippingUsed=false)
	Constructor with parameter initialization.

const QByteArray &	GetId () const
	Get ID of this tag.

quint32	GetBinaryId () const
	Get automatic generated binary ID.

const QByteArray &	GetComment () const
	Get comment of this tag.

TagType	GetTagType () const
	Get type of this tag.

const CArchiveTag *	GetParentTag () const
	Get tag beeing parent of this.

bool	IsTagSkippingUsed () const
	Check if it is needed to support tag skipping for this tag.

Detailed Description

Process tag used to group data in archive stream.

Definition at line 24 of file CArchiveTag.h.

Member Enumeration Documentation

◆ TagType

enum iser::CArchiveTag::TagType

Describe type of tag.

Enumerator
TT_UNKNOWN	Unknown type of tag.
TT_GROUP	Normal tag used for grouping of tags or processed elements. It should be outputted to serialized stream.
TT_MULTIPLE	Multiple tag containing variable number of child tags. All childs must be the same type.
TT_LEAF	Leaf tag, it can contain only one primitive element. Single group can contain only one leaf tag with the same name. Depending on implementation some leaf specific optimizations can be enabled (e.g. using of attributes for XML documents).
TT_WEAK	Weak group tag, if possible it will be not outputted.

Definition at line 30 of file CArchiveTag.h.

Constructor & Destructor Documentation

◆ CArchiveTag() [1/2]

iser::CArchiveTag::CArchiveTag ( )

◆ CArchiveTag() [2/2]

iser::CArchiveTag::CArchiveTag	(	const QByteArray &	id,
		const QByteArray &	comment,
		TagType	tagType = TT_UNKNOWN,
		const CArchiveTag *	parentPtr = nullptr,
		bool	isTagSkippingUsed = false )

Constructor with parameter initialization.

Parameters

id	ID of this tag.
comment	human readable and are used for diagnostic.
isTagSkippingUsed	true if it is needed to support tag skipping for this tag.

Member Function Documentation

◆ GetBinaryId()

quint32 iser::CArchiveTag::GetBinaryId ( ) const

Get automatic generated binary ID.

◆ GetComment()

const QByteArray & iser::CArchiveTag::GetComment ( ) const

Get comment of this tag.

Comments are human readable and are used for diagnostic.

◆ GetId()

const QByteArray & iser::CArchiveTag::GetId ( ) const

Get ID of this tag.

◆ GetParentTag()

const CArchiveTag * iser::CArchiveTag::GetParentTag ( ) const

Get tag beeing parent of this.

◆ GetTagType()

TagType iser::CArchiveTag::GetTagType ( ) const

Get type of this tag.

◆ IsTagSkippingUsed()

bool iser::CArchiveTag::IsTagSkippingUsed ( ) const

inline

Check if it is needed to support tag skipping for this tag.

Definition at line 117 of file CArchiveTag.h.

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

iser/CArchiveTag.h

Public Types

Public Member Functions