MeVisLab/Standard/Sources/ML/MLImageFormat/mlImageFormatFileCache.h

Go to the documentation of this file.

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

// File caching with the ML Image Format.
//----------------------------------------------------------------------------------
#ifndef __mlImageFormatFileCache_H
#define __mlImageFormatFileCache_H

#ifndef __MLImageFormatSystem_H
#include "MLImageFormatSystem.h"
#endif
#ifndef __mlModuleIncludes_H
#include <mlModuleIncludes.h>
#endif
#ifndef __mlImageFormatTools_H
#include <mlImageFormatTools.h>
#endif
#ifndef __mlImageFormatIOBase_H
#include <mlImageFormatIOBase.h>
#endif

ML_START_NAMESPACE

  class MLImageFormat;
  class MLImageFormatCompressionParams;
  
  //----------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------
  class MLIMAGEFORMAT_EXPORT MLImageFormatFileCache : public MLImageFormatIOBase {

  public:

    enum UPDATE_MODE {
      UPDATE_OFF = 0,      
      UPDATE_AUTOUPDATE,   
      UPDATE_AUTOCLEAR,    
      UPDATE_MODE_NUM
    };

    static const char* const UPDATE_MODE_NAMES[UPDATE_MODE_NUM];

    MLImageFormatFileCache();

    virtual ~MLImageFormatFileCache();


    BoolField     &getValidFld            () const { return *_validFld            ; }
    NotifyField   &getLoadFld             () const { return *_loadFld             ; }
    NotifyField   &getUpdateRegionFld     () const { return *_updateRegionFld     ; }
    NotifyField   &getClearFld            () const { return *_clearFld            ; }
    EnumField     &getAutoLoadFld         () const { return *_autoLoadFld         ; }
    StringField   &getTmpFileNamePrefixFld() const { return *_tmpFileNamePrefixFld; }

  protected:
    // ----------------------------------------------------------

    // ----------------------------------------------------------
    virtual void activateAttachments();

    virtual void handleNotification (Field *field);

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

    // ----------------------------------------------------------
    virtual void calculateOutputImageProperties(int outIndex);

    virtual Module::INPUT_HANDLE handleInput(int /*inIndex*/, Module::INPUT_STATE /*state*/) const;

    virtual SubImageBox calculateInputSubImageBox(int /*inIndex*/, 
                                                  const SubImageBox& outSubImgBox, 
                                                  int /*outIndex*/);

    virtual void calculateOutputSubImage(SubImage *outSubImg, int outIndex, SubImage *inSubImgs);


  private:

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

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

    void           _shutDownFileIO(bool forceRemove=false);

    void           _clearOutput(bool forceRemove=false);

    MLErrorCode    _setUpOrOpenCacheFile(bool *cacheWasLoaded=NULL);

    MLErrorCode    _overwriteWithInputInFile();


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

    // ----------------------------------------------------------
    MLImageFormat *_fileManager;

    PagedImage     _inImgProps;


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

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

    BoolField     *_validFld;

    BoolField     *_preserveCacheFileFld;


    NotifyField   *_loadFld;

    NotifyField   *_updateRegionFld;

    NotifyField   *_clearFld;


    EnumField     *_autoLoadFld;

    StringField   *_tmpFileNamePrefixFld;


    ML_MODULE_CLASS_HEADER(MLImageFormatFileCache);
  };

ML_END_NAMESPACE

#endif // of __mlImageFormatFileCache_H