MeVisLabToolboxReference
Public Member Functions | Public Attributes
ml::MLImageFormatIdxTable::PageIdxType Struct Reference

Internal helper class. More...

#include <mlImageFormatIdxTable.h>

List of all members.

Public Member Functions

MLuint32 getCheckSum () const
 added explicitly. Thus it is not part of this struct.
void setCheckSum (MLuint32 sum)
 Returns the checkSum stored in checkSumLow, checkSumMed, and checkSumHigh.
void setFlagByte (MLuint8 newVal)
 Set flag byte to the passed value.
void setPartialFlag (bool isPartialPage)
 Set partial flag for a page, i.e. the page data is stored only as a fragment.
bool getPartialFlag () const
 Returns true if page is stored only partially, otherwise false.

Public Attributes

MLint64 startFilePos
 Position of first data byte of page in file or -1 if page is not stored.
MLint64 endFilePos
 Position of last data byte of page in file or -1 if page is not stored and has only one value.
MLuint8 isCompressed
 1 if page is compressed with compression scheme define in tag ML_COMPRESSION, 0 otherwise.
MLuint8 checkSumLow
 Lowest 8 bit of 24 bit checksum of page data. May be 0 for some file which do not store check sums.
MLuint8 checkSumMed
 Middle 8 bit of 24 bit checksum of page data. May be 0 for some file which do not store check sums.
MLuint8 checkSumHigh
 Highest 8 bit of 24 bit checksum of page data. May be 0 for some file which do not store check sums.
MLuint8 flagByte
 Flag byte containing status information about the stored page.
MLuint8 _internalData [11]
 Still unused data structure for future format extensions.

Detailed Description

Internal helper class.

Index and information structure describing a page stored in the image file, not to be used, because it is subject to change. Note that it stored in the endianess of the system creating the file. WARNING: DO NOT CHANGE SIZE OF THIS DATA STRUCTURE OR STORED FILES WILL BE COMPATIBLE ANY MORE!

Definition at line 50 of file mlImageFormatIdxTable.h.

Member Function Documentation

MLuint32 ml::MLImageFormatIdxTable::PageIdxType::getCheckSum ( ) const [inline]

added explicitly. Thus it is not part of this struct.

Returns the checkSum stored in checkSumLow, checkSumMed, and checkSumHigh.

Definition at line 88 of file mlImageFormatIdxTable.h.

bool ml::MLImageFormatIdxTable::PageIdxType::getPartialFlag ( ) const [inline]

Returns true if page is stored only partially, otherwise false.

Definition at line 116 of file mlImageFormatIdxTable.h.

void ml::MLImageFormatIdxTable::PageIdxType::setCheckSum ( MLuint32  sum) [inline]

Returns the checkSum stored in checkSumLow, checkSumMed, and checkSumHigh.

Definition at line 96 of file mlImageFormatIdxTable.h.

void ml::MLImageFormatIdxTable::PageIdxType::setFlagByte ( MLuint8  newVal) [inline]

Set flag byte to the passed value.

Definition at line 104 of file mlImageFormatIdxTable.h.

void ml::MLImageFormatIdxTable::PageIdxType::setPartialFlag ( bool  isPartialPage) [inline]

Set partial flag for a page, i.e. the page data is stored only as a fragment.

Definition at line 110 of file mlImageFormatIdxTable.h.

Member Data Documentation

MLuint8 ml::MLImageFormatIdxTable::PageIdxType::_internalData[11]

Still unused data structure for future format extensions.

Definition at line 80 of file mlImageFormatIdxTable.h.

MLuint8 ml::MLImageFormatIdxTable::PageIdxType::checkSumHigh

Highest 8 bit of 24 bit checksum of page data. May be 0 for some file which do not store check sums.

Definition at line 72 of file mlImageFormatIdxTable.h.

MLuint8 ml::MLImageFormatIdxTable::PageIdxType::checkSumLow

Lowest 8 bit of 24 bit checksum of page data. May be 0 for some file which do not store check sums.

Definition at line 66 of file mlImageFormatIdxTable.h.

MLuint8 ml::MLImageFormatIdxTable::PageIdxType::checkSumMed

Middle 8 bit of 24 bit checksum of page data. May be 0 for some file which do not store check sums.

Definition at line 69 of file mlImageFormatIdxTable.h.

MLint64 ml::MLImageFormatIdxTable::PageIdxType::endFilePos

Position of last data byte of page in file or -1 if page is not stored and has only one value.

See startFilePos.

Definition at line 59 of file mlImageFormatIdxTable.h.

MLuint8 ml::MLImageFormatIdxTable::PageIdxType::flagByte

Flag byte containing status information about the stored page.

Currently only bit 0 is used; if true it indicates that the stored page is only a page fragment and not complete. If false then entire page data is stored.

Definition at line 77 of file mlImageFormatIdxTable.h.

MLuint8 ml::MLImageFormatIdxTable::PageIdxType::isCompressed

1 if page is compressed with compression scheme define in tag ML_COMPRESSION, 0 otherwise.

Definition at line 63 of file mlImageFormatIdxTable.h.

MLint64 ml::MLImageFormatIdxTable::PageIdxType::startFilePos

Position of first data byte of page in file or -1 if page is not stored.

In the case of -1 the page content has to be restored from the voxel value stored directly after this struct.

Definition at line 55 of file mlImageFormatIdxTable.h.

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