Representation for the DM file as data structure. More...

#include <mlDMTagGroup.h>

Public Member Functions
	DMTagGroup (DMFileReader &reader, MLuint64 originPosition)
	Constructor initializing itself with settings from the reader.
bool	isSorted () const
	Returns 1 if the tag group is sorted, otherwise 0.
bool	isOpen () const
	Returns 1 if the tag group is open, otherwise 0.
MLuint64	getNumberOfTags () const
	Returns the number of tags in this tag group.
const DMTagPtrVector &	getTagEntries () const
	Returns the vector of pointers to TagEntries.
MLuint64	getPositionAfterGroup () const
	Returns the file position after the end of the structure or 0 on failure.
std::string	getAsString (std::string prefix="", const std::string &sep=", ", const std::string &label="", const size_t maxNumBinaryEntries=8, const size_t maxNumStringEntries=20) const

Detailed Description

Representation for the DM file as data structure.

Definition at line 24 of file mlDMTagGroup.h.

Constructor & Destructor Documentation

◆ DMTagGroup()

ml::DMTagGroup::DMTagGroup	(	DMFileReader &	reader,
		MLuint64	originPosition )

Constructor initializing itself with settings from the reader.

Referenced by getAsString().

Member Function Documentation

◆ getAsString()

std::string ml::DMTagGroup::getAsString	(	std::string	prefix = "",
		const std::string &	sep = ", ",
		const std::string &	label = "",
		const size_t	maxNumBinaryEntries = 8,
		const size_t	maxNumStringEntries = 20 ) const

Convert content to a human readable string with the prefix prefix before all lines and separator sep between all structure components. Before all the label is added. If a binary tag is displayed then the number of shown values is controlled with maxNumBinaryEntries; if there are more then "..." is displayed instead. If a binary tag of type Uint16 which might be a unicoded string then the number of shown values is controlled with maxNumStringEntries; if there are more then "..." is displayed instead.

References DMTagGroup().

◆ getNumberOfTags()

MLuint64 ml::DMTagGroup::getNumberOfTags ( ) const

Returns the number of tags in this tag group.

◆ getPositionAfterGroup()

MLuint64 ml::DMTagGroup::getPositionAfterGroup ( ) const

Returns the file position after the end of the structure or 0 on failure.

◆ getTagEntries()

const DMTagPtrVector & ml::DMTagGroup::getTagEntries ( ) const

Returns the vector of pointers to TagEntries.

◆ isOpen()

bool ml::DMTagGroup::isOpen ( ) const

Returns 1 if the tag group is open, otherwise 0.

◆ isSorted()

bool ml::DMTagGroup::isSorted ( ) const

Returns 1 if the tag group is sorted, otherwise 0.

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

FMEstable/ReleaseMeVis/Projects/FileReader/MLDMFileReader/Sources/mlDMTagGroup.h

Public Member Functions