MeVis/Foundation/Sources/MLImageFormatBase/mlImageFormatIdxTable.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------

#ifndef __mlImageFormatIdxTable_H
#define __mlImageFormatIdxTable_H

// Resolve platform independencies.
#ifndef __MLImageFormatBaseSystem_H
#include "MLImageFormatBaseSystem.h"
#endif

#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif

ML_START_NAMESPACE


  class MLImageFormatTagList;

  class MLImageFormatInfos;

  //--------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------
  class MLIMAGEFORMATBASE_EXPORT MLImageFormatIdxTable {

  public:

    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------
    struct PageIdxType {

      MLint64 startFilePos;

      MLint64 endFilePos;

      MLuint8 isCompressed;

      MLuint8 checkSumLow;

      MLuint8 checkSumMed;

      MLuint8 checkSumHigh;

      MLuint8 flagByte;

      MLuint8 _internalData[11];

      // After _internalData the voxel value of the page is stored; it,
      // however, has a size depending on the voxel type and is
      // < PageVoxelType > onePageVoxel.

      inline MLuint32 getCheckSum() const
      {
        return ((static_cast<MLuint32>(checkSumLow )      ) |
                (static_cast<MLuint32>(checkSumMed ) << 8 ) |
                (static_cast<MLuint32>(checkSumHigh) << 16));
      }

      inline void setCheckSum(MLuint32 sum)
      {
        checkSumLow  = (sum      ) & 0xff;
        checkSumMed  = (sum >>  8) & 0xff;
        checkSumHigh = (sum >> 16) & 0xff;
      }

      inline void setFlagByte(MLuint8 newVal)
      {
        flagByte = newVal;
      }

      inline void setPartialFlag(bool isPartialPage)
      {
        flagByte |= (isPartialPage ? 1 : 0);
      }

      inline bool getPartialFlag() const
      {
        return (flagByte & 1) ? true : false;
      }
    };

    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------

    MLImageFormatIdxTable();

    ~MLImageFormatIdxTable();

    MLErrorCode        create(MLint       startIdx,
                              MLint       endIdx,
                              MLint       numAllPageIds,
                              MLDataType  dType,
                              void       *newTableData=NULL,
                              bool        setTable=true);

    void               setTableData(void *newTable);

    void               toggleEndianess();

    void               reset();

    MLErrorCode        setEntry(MLint             pageId,
                                MLint             pageDataStartPosInFile,
                                MLint             pageDataEndPosInFile,
                                bool              isCompressed,
                                MLuint32          checkSum,
                                bool              isPartial,
                                const MLTypeData *defaultVoxelData);

    const PageIdxType *getConstEntry(MLint pageId) const;

    PageIdxType       *getEntry(MLint pageId);

    const MLTypeData  *getConstEntryVoxelData(MLint pageId) const;

    MLTypeData        *getEntryVoxelData(MLint pageId);

    MLint              getNumAllocatedPageIds() const;

    MLint              getNumImagePageIds() const;

    MLint              getAllocatedTableSizeInBytes() const;

    MLint              getWholeTableSizeInBytes() const;

    MLErrorCode        load(const MLImageFormatInfos   &infos,
                            MLint                      numWholePageIds);

    MLErrorCode         save(int    fd,
                             MLuint idxTabBasePos);

    private:

      MLint       _firstEntry;

      MLint       _lastEntry;

      MLint       _numAllocatedTableEntries;

      MLint       _numImagePageIds;

      MLint       _sizeOfOneVoxel;

      MLDataType  _voxelType;

      MLint       _idxTabEntrySize;

      void       *_tablePtr;

  private:

    inline MLImageFormatIdxTable(const MLImageFormatIdxTable &){ }

    inline MLImageFormatIdxTable &operator=(const MLImageFormatIdxTable &){ return *this; }

  };

ML_END_NAMESPACE

#endif // __mlImageFormatIdxTable_H