mlImageFormatFileCache.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_IMAGE_FORMAT_FILE_CACHE_H
#define ML_IMAGE_FORMAT_FILE_CACHE_H
 

 
#include "MLImageFormatSystem.h"
#include <mlModuleIncludes.h>
#include <mlImageFormatTools.h>
#include <mlImageFormatIOBase.h>
 
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();

    ~MLImageFormatFileCache() override;

    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:
    // ----------------------------------------------------------
    // ----------------------------------------------------------
    void activateAttachments() override;

    void handleNotification (Field *field) override;
 
    // ----------------------------------------------------------
    // ----------------------------------------------------------
    void calculateOutputImageProperties(int outputIndex, PagedImage* outputImage) override;

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

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

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

 
  private:
 
    // ----------------------------------------------------------
    // ----------------------------------------------------------
 
    // Handle a special case where preserveCacheFile is being enabled while a temporary
    // cache file exists. To avoid a file leak we need to remove the temporary cache
    // file, but not the file given by the (prefix) path.
    virtual bool _handlePreserveCacheFileFlagChange(Field* field);

    void           _shutDownFileIO(bool forceRemove=false);

    void           _clearOutput(bool forceRemove=false);

    MLErrorCode    _setUpOrOpenCacheFile(bool *cacheWasLoaded=nullptr);

    MLErrorCode    _overwriteWithInputInFile();
 
 
    // ----------------------------------------------------------
    // ----------------------------------------------------------
    MLImageFormat *_fileManager;

    PagedImage     _inImgProps;
 
 
    // ----------------------------------------------------------
    // ----------------------------------------------------------

    BoolField     *_validFld;

    BoolField     *_preserveCacheFileFld;
 

    NotifyField   *_loadFld;

    NotifyField   *_updateRegionFld;

    NotifyField   *_clearFld;
 

    EnumField     *_autoLoadFld;

    StringField   *_tmpFileNamePrefixFld;

    StringField   *_outFullCacheFilePathFld;
 

    ML_MODULE_CLASS_HEADER(MLImageFormatFileCache);
  };
 
ML_END_NAMESPACE
 
#endif // of __mlImageFormatFileCache_H