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

Go to the documentation of this file.

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

//
// ML Image Format IO
//----------------------------------------------------------------------------------

#ifndef __mlImageFormatIOBase_H
#define __mlImageFormatIOBase_H


// Local includes
#ifndef __MLImageFormatSystem_H
#include "MLImageFormatSystem.h"
#endif

// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif

#ifndef __mlImageFormatTools_H
#include "mlImageFormatTools.h"
#endif


ML_START_NAMESPACE

// Forward declaration.
class MLImageFormat;
class MLImageFormatCompressionParams;

// ----------------------------------------------------------
// ----------------------------------------------------------
class MLIMAGEFORMAT_EXPORT MLImageFormatIOBase : public Module
{
public:
  
  // Define number of user tags to support as fields and in GUI.
  enum { NumUserTags = 10 };

  MLImageFormatIOBase(int numIns=0, int numOuts=0);

  virtual ~MLImageFormatIOBase();

  MLImageFormatTagList getUserTagList() const;

  virtual void updateUserTagFieldsFromLoader(const MLImageFormat &loader);

  virtual void updateTagListFieldFromLoader(const MLImageFormat &loader);

protected:

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

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

  virtual void handleNotification (Field *field);

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

  // ----------------------------------------------------------
  virtual void _setStatus(std::string str      = "", 
                          float       progress = 0.0,   
                          MLErrorCode err      = ML_RESULT_OK);


  virtual void _setProgress(float progressVal);

  virtual void _resetTagFields();

  virtual void _remove(const std::string &fileName, bool updateStatus);

  static void  _saveCB(MLint id,      
                       MLint idNum,      
                       MLImageFormatTools::ProcessState state,   
                       void  *usrData, 
                       bool  &interrupt);

  void  _saveCBMethod(MLint id,      
                      MLint idNum,      
                      MLImageFormatTools::ProcessState state,   
                      bool  &interrupt);


  MLErrorCode _overWriteWithInputImage(PagedImage    &inImg, 
                                       MLImageFormat &fileToUpdate, 
                                       ImageVector    voxelShift                = ImageVector(0),
                                       PagedImage    *imgPropsToUpdate          = NULL,
                                       bool          suppressWorldCoordinateUse = false);

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

  // ----------------------------------------------------------
  MLImageFormatCompressionParams &_getCompressorParams   ()       { return *_compressorParams   ; }
  TimeCounter                    &_getTimer              ()       { return  _timer              ; }
  BoolField                      &_getIsSavingFld        ()       { return *_isSavingFld        ; }
            
  const StringField              &_getTrueFileNameFld    () const { return *_trueFileNameFld    ; }
  const EnumField                &_getUpdateModeFld      () const { return *_updateModeFld      ; }
  const NotifyField              &_getStopFld            () const { return *_stopFld            ; }
  const NotifyField              &_getRemoveFld          () const { return *_removeFld          ; }
  const StringField              &_getStatusFld          () const { return *_statusFld          ; }
  const ProgressField            &_getProgressFld        () const { return *_progressFld        ; }
  const StringField              &_getTagListFld         () const { return *_tagListFld         ; }
  const StringField* const*       _getUserTagFlds        () const { return  _userTagFld         ; }
  StringField                    &_getNonConstTagListFld () const { return *_tagListFld         ; }
  StringField                   **_getNonConstUserTagFlds()       { return  _userTagFld         ; }
  ImageVectorField               &_getRegionOffsetFld    () const { return *_regionOffsetFld    ; }
  BoolField                      &_getSuppressWorldPosFld() const { return *_suppressWorldPosFld; }

private:

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

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

  MLImageFormatCompressionParams *_compressorParams;

  TimeCounter    _timer;

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

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

  StringField   *_trueFileNameFld;

  ProgressField *_progressFld;

  EnumField     *_updateModeFld;

  NotifyField   *_stopFld;

  NotifyField   *_removeFld;

  StringField   *_statusFld;

  BoolField     *_isSavingFld;

  StringField   *_tagListFld;

  StringField   *_userTagFld[NumUserTags];

  ImageVectorField   *_regionOffsetFld;
  
  BoolField     *_suppressWorldPosFld;


  ML_MODULE_CLASS_HEADER(MLImageFormatIOBase)
};


ML_END_NAMESPACE

#endif // __mlImageFormatIOBase_H