Class defining a list of tags used in the MLImageFormat class. More...

#include <mlImageFormatTagList.h>

Inherits std::vector< T >.

Public Member Functions
Basic class stuff, constructor, destructor, assignment etc.
	MLImageFormatTagList ()
	Default constructor, setting name and value to empty strings.
MLuint	getTagListSizeInBytes () const
	Returns sum of sizes of all tag names and values of all tags including their terminating 0 characters or 0 on failure.
void	tagListOut (std::ostream &ostr) const
	Passes the tag list into a the stream ostr.
std::string	getTagListAsString () const
	Passes the tag list into a the string str.
const MLImageFormatTag *	findConstTag (const std::string &tagName) const
	Returns pointer to first tag in list with name tagName or NULL if not found.
MLint	findTagIdx (const std::string &tagName) const
	Returns index to first tag in list with name tagName or -1 if not found or on failure.
bool	checkTag (const std::string &tagName, MLint &val) const
	Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.
bool	checkTag (const std::string &tagName, std::string &val) const
	Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.
bool	checkTag (const std::string &tagName, MLdouble &val) const
	Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.
bool	checkTag (const std::string &tagName, MLldouble &val) const
	Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.
MLint	getExpectedHeaderAndListSizeAsBinary () const
	Returns the number of bytes which would be needed to store the header and tag list in memory before writing it to the file.
char *	getHeaderAndListAsBinary (size_t &memSize, MLuint32 saveModeBits) const
	Create a memory buffer and fill if first with a null-terminated versionStr followed by all tagNames and values from the list.
MLErrorCode	save (int fd, MLuint filePos, MLuint32 saveModeBits) const
	Writes the tag list into an open and writable file to position filePos or to the current file position.
MLErrorCode	load (int fd, MLint filePos=0)
	Reads the tag list from start of open file given by valid descriptor fd for a readable and open file.
MLErrorCode	appendImageProperties (const PagedImage &props, const DataCompressor *compressor, const MLImageFormatTagList &compressionTagList, const MLImageFormatTagList &userTagList, const MLImageFormatTagList &privateTagList, const std::string &defaultVoxelValue, MLuint32 saveModeBits)
	Append image properties and other information to tagList.
MLErrorCode	extractImageProperties (PagedImage &props, MLint &endianess, std::string &compressorName, std::string &compressorVersion, MLImageFormatTagList &compressionTagList, MLImageFormatTagList &userTagList, MLImageFormatTagList &privateTagList, std::string &defaultVoxelValue, MLint &usesCheckSum, MLint &usesPartialPages)
	Gets image properties from a non empty tag list, empty lists are considered okay, only safely found settings are changed in the return values.
MLErrorCode	extractImageProperties (MLImageFormatInfos &infos)
	Gets all image properties of infos except of the.
void	appendSpecialTags (const std::string &numTagsTagName, const std::string &tagNamePrefix, const MLImageFormatTagList &sourceTagList)
	Helper function to special tags in a standardized way to the tag list.
MLErrorCode	extractSpecialTags (const std::string &numTagsTagName, const std::string &tagNamePrefix, MLImageFormatTagList &targetTagList) const
	Helper function to extract special tags in a standardized way from this tag list into a target tag list.
Static Public Member Functions
static const MLImageFormatTagList &	getDefaultEmptyTagList ()
	Returns a default empty tags list.
Static Public Attributes
static const MLint	ML_LITTLE_ENDIAN
	Little endian.
static const MLint	ML_BIG_ENDIAN
	Big endian.
static const std::string	ML_DICOM_TAG_PREFIX
	Name prefix for all stored DICOM tags.
static const std::string	ML_TAG_LIST_SIZE_IN_BYTES_TAG
	Name of first tag whose value denotes the size of the entire tag list size.

Detailed Description

Class defining a list of tags used in the MLImageFormat class.

Definition at line 40 of file mlImageFormatTagList.h.

Constructor & Destructor Documentation

ml::MLImageFormatTagList::MLImageFormatTagList ( ) [inline]

Default constructor, setting name and value to empty strings.

Definition at line 71 of file mlImageFormatTagList.h.

Member Function Documentation

MLErrorCode ml::MLImageFormatTagList::appendImageProperties	(	const PagedImage &	props,
		const DataCompressor *	compressor,
		const MLImageFormatTagList &	compressionTagList,
		const MLImageFormatTagList &	userTagList,
		const MLImageFormatTagList &	privateTagList,
		const std::string &	defaultVoxelValue,
		MLuint32	saveModeBits
	)

Append image properties and other information to tagList.

Convenience function, independent of open files etc.

Parameters:

props	the properties to be stored in tag list.
compressor	name of the data compressor stored in tag list.
compressionTagList	additional arguments for compressor to be stored in list.
userTagList	user tags to be added to tag list.
privateTagList	private tags to be added to tag list.
defaultVoxelValue	default voxel value for unstored pages to be stored in list.
saveModeBits	Bit combination setting special save options: See MLImageFormatTools::SaveModeBits for possible options.

Returns:: ML_RESULT_OK on success or on failure an MLErrorCode describing the problem.

void ml::MLImageFormatTagList::appendSpecialTags	(	const std::string &	numTagsTagName,
		const std::string &	tagNamePrefix,
		const MLImageFormatTagList &	sourceTagList
	)

Helper function to special tags in a standardized way to the tag list.

Parameters:

numTagsTagName	The name of the tag which will store the of added tags.
tagNamePrefix	Prefix added before each name of added tags. tagNamePrefix must not contain ":" characters.
sourceTagList	List of special tags to be added.

bool ml::MLImageFormatTagList::checkTag	(	const std::string &	tagName,
		std::string &	val
	)		const

Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.

On failure false is returned and val is left unchanged.

bool ml::MLImageFormatTagList::checkTag	(	const std::string &	tagName,
		MLdouble &	val
	)		const

Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.

On failure false is returned and val is left unchanged.

bool ml::MLImageFormatTagList::checkTag	(	const std::string &	tagName,
		MLldouble &	val
	)		const

Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.

On failure false is returned and val is left unchanged.

bool ml::MLImageFormatTagList::checkTag	(	const std::string &	tagName,
		MLint &	val
	)		const

Searches tag with name tagName in list and if it exists then its value is read into val and true is returned.

On failure false is returned and val is left unchanged.

MLErrorCode ml::MLImageFormatTagList::extractImageProperties	(	PagedImage &	props,
		MLint &	endianess,
		std::string &	compressorName,
		std::string &	compressorVersion,
		MLImageFormatTagList &	compressionTagList,
		MLImageFormatTagList &	userTagList,
		MLImageFormatTagList &	privateTagList,
		std::string &	defaultVoxelValue,
		MLint &	usesCheckSum,
		MLint &	usesPartialPages
	)

Gets image properties from a non empty tag list, empty lists are considered okay, only safely found settings are changed in the return values.

Parameters:

props	is filled with the properties of the stored file.
endianess	returns the endianess of the data in the file.
compressorName	returns the name of the data compressor used for that file.
compressorVersion	returns the version of the data compressor used for that file.
compressionTagList	returns compressionScheme and additional arguments.
userTagList	returns the list with user defined tags.
privateTagList	returns the list with private tags.
defaultVoxelValue	returns the default voxel value for non stored pages.
usesCheckSum	returns non zero if data is stored with check sum, otherwise 0.
usesPartialPages	returns non zero if pages are potentially only stored partially, otherwise 0.

Returns:: ML_RESULT_OK on success or on failure an MLErrorCode describing the problem.

MLErrorCode ml::MLImageFormatTagList::extractImageProperties ( MLImageFormatInfos & infos )

Gets all image properties of infos except of the.

infos.fd,
infos.fileName,
infos.idxTab, and
infos.tagList from a non empty tag list given by this. Empty lists are considered okay, only safely found settings are changed in the passed info parameter. Does the same as extractImageProperties(...) with multiple parameters.
Parameters:

infos The information object to be filled with extracted information.

Returns:
ML_RESULT_OK on success or on failure an MLErrorCode describing the problem.

MLErrorCode ml::MLImageFormatTagList::extractSpecialTags	(	const std::string &	numTagsTagName,
		const std::string &	tagNamePrefix,
		MLImageFormatTagList &	targetTagList
	)		const

Helper function to extract special tags in a standardized way from this tag list into a target tag list.

See symmetric function appendSpecialTagsToTagList().

Parameters:

numTagsTagName	The name of the tag which contains the number of added tags.
tagNamePrefix	Prefix added before each name of added tags. tagNamePrefix must not contain ":" characters.
targetTagList	List in which to store the extracted tags.

Returns:: ML_RESULT_OK on success or an error code on failure.

const MLImageFormatTag* ml::MLImageFormatTagList::findConstTag ( const std::string & tagName ) const

Returns pointer to first tag in list with name tagName or NULL if not found.

MLint ml::MLImageFormatTagList::findTagIdx ( const std::string & tagName ) const

Returns index to first tag in list with name tagName or -1 if not found or on failure.

static const MLImageFormatTagList& ml::MLImageFormatTagList::getDefaultEmptyTagList ( ) [static]

Returns a default empty tags list.

MLint ml::MLImageFormatTagList::getExpectedHeaderAndListSizeAsBinary ( ) const

Returns the number of bytes which would be needed to store the header and tag list in memory before writing it to the file.

char* ml::MLImageFormatTagList::getHeaderAndListAsBinary	(	size_t &	memSize,
		MLuint32	saveModeBits
	)		const

Create a memory buffer and fill if first with a null-terminated versionStr followed by all tagNames and values from the list.

Parameters:

memSize	returns the size of the allocated memory or 0 on failure.
saveModeBits	Bit combination setting special save options: See MLImageFormatTools::SaveModeBits for possible options.

Returns:: the pointer to the created memory block or NULL on failure. The memory must be freed by the caller with Memory::freeMemory() or MLFree().

std::string ml::MLImageFormatTagList::getTagListAsString ( ) const

Passes the tag list into a the string str.

MLuint ml::MLImageFormatTagList::getTagListSizeInBytes ( ) const

Returns sum of sizes of all tag names and values of all tags including their terminating 0 characters or 0 on failure.

MLErrorCode ml::MLImageFormatTagList::load	(	int	fd,
		MLint	filePos = `0`
	)

Reads the tag list from start of open file given by valid descriptor fd for a readable and open file.

The tagList will be reset always on start of call. On failure the tag list is reset/emptied.

Parameters:

fd	The descriptor for the file opened for reading.
filePos	The position in file where to read the table from. Should normally be 0, the default.

Returns:: ML_RESULT_OK on success or on failure an MLErrorCode describing the problem.

MLErrorCode ml::MLImageFormatTagList::save	(	int	fd,
		MLuint	filePos,
		MLuint32	saveModeBits
	)		const

Writes the tag list into an open and writable file to position filePos or to the current file position.

Parameters:

fd	must be a valid file descriptor of an open and writable file.
filePos	is the position where to write the data.
saveModeBits	Bit combination setting special save options: See MLImageFormatTools::SaveModeBits for possible options.