ml::DMTag Class Reference

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

#include <mlDMTag.h>

Public Member Functions
	DMTag (DMFileReader &reader, MLuint64 originPosition)
	Constructor initialized with its reader and its position in the file.
bool	isGroupTag () const
	Returns true if the tag is a group, otherwise false.
DMTagGroupPtr	getTagGroup () const
	Returns the DMTagGroup instance if isGroup() is true, otherwise it returns nullptr.
bool	isDataTag () const
	Returns true if the tag Entry is data, otherwise false.
DMTagDataPtr	getTagData () const
	Returns the DMTagData instance if isData() is true, otherwise it returns nullptr.
MLuint64	getLabelSize () const
	Returns the size of the entrie's label.
std::string	getLabel () const
	Returns the entrie's label.
MLuint64	getPositionAfterLabel () const
	Returns the file position after the label.
MLuint64	getPositionAfterEnd () const
	Returns the file position after the end of the tag or 0 if not valid any more.
MLuint64	getFilePosition () const
	Returns the file position from where the tag tag was read.
std::string	getAsString (std::string prefix="", const std::string &sep=", ", 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.

Detailed Description

Representation for the DM file as data structure.

Definition at line 24 of file mlDMTag.h.

Constructor & Destructor Documentation

DMTag()

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

Constructor initialized with its reader and its position in the file.

Member Function Documentation

getAsString()

std::string ml::DMTag::getAsString	(	std::string	prefix = "",
		const std::string &	sep = ", ",
		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.

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.

getFilePosition()

MLuint64 ml::DMTag::getFilePosition

(

)

const

Returns the file position from where the tag tag was read.

getLabel()

std::string ml::DMTag::getLabel

(

)

const

Returns the entrie's label.

getLabelSize()

MLuint64 ml::DMTag::getLabelSize

(

)

const

Returns the size of the entrie's label.

getPositionAfterEnd()

MLuint64 ml::DMTag::getPositionAfterEnd

(

)

const

Returns the file position after the end of the tag or 0 if not valid any more.

getPositionAfterLabel()

MLuint64 ml::DMTag::getPositionAfterLabel

(

)

const

Returns the file position after the label.

getTagData()

DMTagDataPtr ml::DMTag::getTagData

(

)

const

Returns the DMTagData instance if isData() is true, otherwise it returns nullptr.

getTagGroup()

DMTagGroupPtr ml::DMTag::getTagGroup

(

)

const

Returns the DMTagGroup instance if isGroup() is true, otherwise it returns nullptr.

isDataTag()

bool ml::DMTag::isDataTag

(

)

const

Returns true if the tag Entry is data, otherwise false.

isGroupTag()

bool ml::DMTag::isGroupTag

(

)

const

Returns true if the tag is a group, otherwise false.

---

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

• FMEstable/ReleaseMeVis/Projects/FileReader/MLDMFileReader/Sources/mlDMTag.h