ml::MLImageFormatInfos Class Reference

A internal structure containing information about an opened file, not to be used, because it is subject to change. More...

#include <mlImageFormatInfos.h>

List of all members.

Public Member Functions
	MLImageFormatInfos ()
	Standard constructor.
	~MLImageFormatInfos ()
	Destructor to clean up.
void	reset ()
	Reset to construction state.
Public Attributes
std::string	fileName
	The name of the file, default is "".
int	fd
	The descriptor of the file; -1 if closed, otherwise >= 0.
std::string	defaultVoxelValue
	String representation of a default value for voxels outside written image areas, a "background value".
MLint	endianess
	Endianess of the file.
MLint	usesCheckSum
	Non zero if index tables stores page checksum values, zero otherwise.
MLint	usesPartialPages
	Non zero if pages are allowed to be stored partially, zero otherwise.
PagedImage	props
	A PagedImage instance as property container.
MLImageFormatIdxTable	idxTab
	Index table with location and storage information for pages.
DataCompressor *	compressor
	Pointer to data compressor instance if available or NULL.
std::string	compressorName
	Name of data compressor used for page data or "" if not available.
std::string	compressorVersion
	Version of data compressor used for page data or "" if not available.
MLImageFormatTagList	compressionTagList
	Compression information stored as string values.
MLImageFormatTagList	userTagList
	List of all user defined tags.
MLImageFormatTagList	privateTagList
	List of all private tags.
MLImageFormatTagList	tagList
	List of all tags.

---

Detailed Description

A internal structure containing information about an opened file, not to be used, because it is subject to change.

Definition at line 51 of file mlImageFormatInfos.h.

---

Constructor & Destructor Documentation

ml::MLImageFormatInfos::MLImageFormatInfos

(

)

[inline]

Standard constructor.

Definition at line 55 of file mlImageFormatInfos.h.

ml::MLImageFormatInfos::~MLImageFormatInfos

(

)

[inline]

Destructor to clean up.

Definition at line 58 of file mlImageFormatInfos.h.

---

Member Function Documentation

void ml::MLImageFormatInfos::reset

(

)

[inline]

Reset to construction state.

Definition at line 61 of file mlImageFormatInfos.h.

References ML_DELETE, MLIsLittleEndian(), and ml::PagedImage::setImageProperties().

---

Member Data Documentation

MLImageFormatTagList ml::MLImageFormatInfos::compressionTagList

Compression information stored as string values.

Definition at line 120 of file mlImageFormatInfos.h.

DataCompressor* ml::MLImageFormatInfos::compressor

Pointer to data compressor instance if available or NULL.

Definition at line 111 of file mlImageFormatInfos.h.

std::string ml::MLImageFormatInfos::compressorName

Name of data compressor used for page data or "" if not available.

Definition at line 114 of file mlImageFormatInfos.h.

std::string ml::MLImageFormatInfos::compressorVersion

Version of data compressor used for page data or "" if not available.

Definition at line 117 of file mlImageFormatInfos.h.

std::string ml::MLImageFormatInfos::defaultVoxelValue

String representation of a default value for voxels outside written image areas, a "background value".

Definition at line 93 of file mlImageFormatInfos.h.

MLint ml::MLImageFormatInfos::endianess

Endianess of the file.

Definition at line 96 of file mlImageFormatInfos.h.

int ml::MLImageFormatInfos::fd

The descriptor of the file; -1 if closed, otherwise >= 0.

Definition at line 89 of file mlImageFormatInfos.h.

std::string ml::MLImageFormatInfos::fileName

The name of the file, default is "".

Definition at line 86 of file mlImageFormatInfos.h.

MLImageFormatIdxTable ml::MLImageFormatInfos::idxTab

Index table with location and storage information for pages.

Definition at line 108 of file mlImageFormatInfos.h.

MLImageFormatTagList ml::MLImageFormatInfos::privateTagList

List of all private tags.

Definition at line 126 of file mlImageFormatInfos.h.

PagedImage ml::MLImageFormatInfos::props

A PagedImage instance as property container.

Definition at line 105 of file mlImageFormatInfos.h.

MLImageFormatTagList ml::MLImageFormatInfos::tagList

List of all tags.

Definition at line 129 of file mlImageFormatInfos.h.

MLImageFormatTagList ml::MLImageFormatInfos::userTagList

List of all user defined tags.

Definition at line 123 of file mlImageFormatInfos.h.

MLint ml::MLImageFormatInfos::usesCheckSum

Non zero if index tables stores page checksum values, zero otherwise.

Definition at line 99 of file mlImageFormatInfos.h.

MLint ml::MLImageFormatInfos::usesPartialPages

Non zero if pages are allowed to be stored partially, zero otherwise.

Definition at line 102 of file mlImageFormatInfos.h.

---

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

• MeVis/Foundation/Sources/MLImageFormatBase/mlImageFormatInfos.h