A internal structure containing information about an opened file. More...

#include <mlImageFormatInfos.h>

Public Member Functions
	MLImageFormatInfos ()
	Standard constructor.

	~MLImageFormatInfos ()
	Destructor to clean up.

void	reset ()
	Resets to construction state.

Public Attributes
MLImageFormatAbstractFileHandle *	fileHandle
	The descriptor of the file; NULL if closed.

std::string	defaultVoxelValue
	String representation of a default value for voxels outside written image areas, a 'background value'.

MLint	endianess
	Endianness 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, as it is subject to change.

Definition at line 44 of file mlImageFormatInfos.h.

Constructor & Destructor Documentation

◆ MLImageFormatInfos()

ml::MLImageFormatInfos::MLImageFormatInfos ( )

Standard constructor.

◆ ~MLImageFormatInfos()

ml::MLImageFormatInfos::~MLImageFormatInfos ( )

Destructor to clean up.

Member Function Documentation

◆ reset()

void ml::MLImageFormatInfos::reset ( )

Resets to construction state.

Member Data Documentation

◆ compressionTagList

MLImageFormatTagList ml::MLImageFormatInfos::compressionTagList

Compression information stored as string values.

Definition at line 88 of file mlImageFormatInfos.h.

◆ compressor

DataCompressor* ml::MLImageFormatInfos::compressor

Pointer to data compressor instance if available or NULL.

Definition at line 79 of file mlImageFormatInfos.h.

◆ compressorName

std::string ml::MLImageFormatInfos::compressorName

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

Definition at line 82 of file mlImageFormatInfos.h.

◆ compressorVersion

std::string ml::MLImageFormatInfos::compressorVersion

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

Definition at line 85 of file mlImageFormatInfos.h.

◆ defaultVoxelValue

std::string ml::MLImageFormatInfos::defaultVoxelValue

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

Definition at line 61 of file mlImageFormatInfos.h.

◆ endianess

MLint ml::MLImageFormatInfos::endianess

Endianness of the file.

Definition at line 64 of file mlImageFormatInfos.h.

◆ fileHandle

MLImageFormatAbstractFileHandle* ml::MLImageFormatInfos::fileHandle

The descriptor of the file; NULL if closed.

Definition at line 57 of file mlImageFormatInfos.h.

◆ idxTab

MLImageFormatIdxTable ml::MLImageFormatInfos::idxTab

Index table with location and storage information for pages.

Definition at line 76 of file mlImageFormatInfos.h.

◆ privateTagList

MLImageFormatTagList ml::MLImageFormatInfos::privateTagList

List of all private tags.

Definition at line 94 of file mlImageFormatInfos.h.

◆ props

PagedImage ml::MLImageFormatInfos::props

A PagedImage instance as property container.

Definition at line 73 of file mlImageFormatInfos.h.

◆ tagList

MLImageFormatTagList ml::MLImageFormatInfos::tagList

List of all tags.

Definition at line 97 of file mlImageFormatInfos.h.

◆ userTagList

MLImageFormatTagList ml::MLImageFormatInfos::userTagList

List of all user defined tags.

Definition at line 91 of file mlImageFormatInfos.h.

◆ usesCheckSum

MLint ml::MLImageFormatInfos::usesCheckSum

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

Definition at line 67 of file mlImageFormatInfos.h.

◆ usesPartialPages

MLint ml::MLImageFormatInfos::usesPartialPages

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

Definition at line 70 of file mlImageFormatInfos.h.

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

MeVis/Foundation/Sources/MLImageFormatBase/mlImageFormatInfos.h

Public Member Functions

Public Attributes