MeVis/Foundation/Sources/MLImageFormatBase/mlImageFormatTagList.h

Go to the documentation of this file.

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

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

#ifndef __mlImageFormatTagList_H
#define __mlImageFormatTagList_H

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

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

#ifndef __mlImageFormatTag_H
#include "mlImageFormatTag.h"
#endif

// Implement everything in ML namespace.
ML_START_NAMESPACE

  class DataCompressor;

  class MLImageFormatInfos;

  //----------------------------------------------------------------------
  //----------------------------------------------------------------------
  class MLIMAGEFORMATBASE_EXPORT  MLImageFormatTagList : public std::vector<MLImageFormatTag>{
    public:

      //----------------------------------------------------------------------
      // CPU specific storage order of data in memory.
      //----------------------------------------------------------------------
      static const MLint        ML_LITTLE_ENDIAN   ; 
      static const MLint        ML_BIG_ENDIAN      ; 

      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static const std::string  ML_DICOM_TAG_PREFIX;

      //--------------------------------------------------------------------------------
      //--------------------------------------------------------------------------------
      static const std::string  ML_TAG_LIST_SIZE_IN_BYTES_TAG;

      //--------------------------------------------------------------------------------
      //--------------------------------------------------------------------------------
      static const MLImageFormatTagList &getDefaultEmptyTagList();


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

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

      MLImageFormatTagList() {}

      MLuint getTagListSizeInBytes() const;

      void tagListOut(std::ostream &ostr) const;

      std::string getTagListAsString() const;

      const MLImageFormatTag *findConstTag(const std::string &tagName) const;

      MLint findTagIdx(const std::string &tagName) const;

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

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

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

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

      MLint getExpectedHeaderAndListSizeAsBinary() const;

      char* getHeaderAndListAsBinary(size_t   &memSize,
                                     MLuint32 saveModeBits) const;

      MLErrorCode save(int      fd,
                       MLuint   filePos,
                       MLuint32 saveModeBits) const;

      MLErrorCode load(int fd, MLint filePos=0);


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

      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);

      MLErrorCode extractImageProperties(MLImageFormatInfos &infos);

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

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

ML_END_NAMESPACE

#endif // of __mlImageFormatTagList_H