mlDMFileReaderTools.h File Reference

Some tool functions for file reader. More...

#include "MLDMFileReaderSystem.h"
#include <mlDMFileReaderDefs.h>

Go to the source code of this file.

Namespaces
namespace	ml
	Main documentation file for ML users and developers.

Functions
MLDMFileReader_EXPORT std::string	ml::DMGetDataTypeAsString (DMEncodedStructureType encType)
	Returns a human readable string version for the provided encType.
MLDMFileReader_EXPORT MLDataType	ml::DMEncodedStructureTypeToMLType (DMEncodedStructureType encType)
	Converts encType to the corresponding MLDataType or to ML_INVALID_DATA_TYPE if not possible.
MLDMFileReader_EXPORT MLDataType	ml::DMPixelDataTypeToMLType (DMEncodedVoxelDataType encType)
	Converts a DM pixel data type to the corresponding MLDataType or to ML_INVALID_DATA_TYPE if not possible.
MLDMFileReader_EXPORT MLuint64	ml::DMGetEncodedSimpleTypeByteSize (DMEncodedStructureType encType)
	Returns the byte size of the encoded simple, on arrays, structs or bad types it returns 0.
MLDMFileReader_EXPORT double	ml::DMGetSimpleEncodedMemoryValueAsDouble (DMFileReader &reader, MLuint64 dataPos, DMEncodedStructureType encType, MLuint64 byteOffset=0)
MLDMFileReader_EXPORT MLuint64	ml::DMGetSimpleEncodedMemoryValueAsMLuint64 (DMFileReader &reader, MLuint64 dataPos, DMEncodedStructureType encType, MLuint64 byteOffset=0)
MLDMFileReader_EXPORT MLint64	ml::DMGetSimpleEncodedMemoryValueAsMLint64 (DMFileReader &reader, MLuint64 dataPos, DMEncodedStructureType encType, MLuint64 byteOffset=0)
MLDMFileReader_EXPORT DMTagPtr	ml::DMGetTag (const std::string &label, const DMTagPtrVector &tagVec)
	Returns the first tag with label in tagVec or nullptr if not found.
MLDMFileReader_EXPORT DMTagPtrVector	ml::DMGetTags (const std::string &label, const DMTagPtrVector &tagVec)
	Returns all tags with label in tagVec or an empty vector if not found.
MLDMFileReader_EXPORT DMTagPtrVector	ml::DMGetTags (const std::string &groupTagName1, const std::string &groupTagName2, const DMTagPtrVector &tagVec)
	If possible then search the first group tag with groupTagName1 in tagVec, and search first group tag with groupTagName2 in it and return its tag vector.
MLDMFileReader_EXPORT DMTagPtrVector	ml::DMGetTags (const std::string &groupTagName1, const std::string &groupTagName2, const std::string &groupTagName3, const DMTagPtrVector &tagVec)
	If possible then search the first group tag with groupTagName1 in tagVec, and search first group tag with groupTagName2 in it and search first group with groupTagName3 and return its tag vector.
MLDMFileReader_EXPORT DMTagPtr	ml::DMGetTag (const std::string &groupTagName1, const std::string &tagName, const DMTagPtrVector &tagVec)
	If possible then search the first group tag with groupTagName1 in tagVec, and search the first tag with tagName in it and return it.
MLDMFileReader_EXPORT DMTagPtr	ml::DMGetTag (const std::string &groupTagName1, const std::string &groupTagName2, const std::string &tagName, const DMTagPtrVector &tagVec)
	If possible then search the first group tag with groupTagName1 in tagVec, then search the first tag with tagGroupName2 in its tags and then search the first tag with tagName in it and return it.
MLDMFileReader_EXPORT DMTagPtr	ml::DMGetTag (const std::string &groupTagName1, const std::string &groupTagName2, const std::string &groupTagName3, const std::string &tagName, const DMTagPtrVector &tagVec)
	If possible then search the first group tag with groupTagName1 in tagVec, then search the first tag with tagGroupName2 in its tags, then search the first tag with tagGroupName3 in its tags and then search the first tag with tagName in it and return it.
MLDMFileReader_EXPORT std::vector< DMImageDataStructPtr >	ml::DMSetUpImageStructs (DMFileReader &reader)
	Search all image data structures in the open reader and return them as list.

Detailed Description

Some tool functions for file reader.

Author

Wolf Spindler

Date

11/2014

Definition in file mlDMFileReaderTools.h.