mlMultiFileVolumeListView.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include <MLMultiFileVolumeListOutputsSystem.h>
 
// ML includes
#include <mlModuleIncludes.h>
 
// DCMTree stuff.
#include <DCMTree_Tree.h>
 
ML_START_NAMESPACE
 
// Forwards to internally used classes.
class MultiFileVolume;
class MultiFileVolumeList;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDIRECTDICOMIMPORTOUTPUTS_EXPORT MultiFileVolumeListView
{
public:

  enum IconBuildMode {
    UseFirstSlice  = 0,     
    UseMiddleSlice,         
 
    NumIconBuildModes       
  };

  static const char * const IconBuildModeStrings[NumIconBuildModes];

  MultiFileVolumeListView();

  virtual ~MultiFileVolumeListView();

  void appendFields(FieldContainer &fieldContainer);

  void checkSortParameters() const;

  void handleNotification(Field &field,
                          bool &updateVolumeListViewFlag,
                          bool &updateThumbNails,
                          bool &updateTableSort,
                          bool isResultCachingPossible);

  void updateSortOrderOfVolumeTable(MultiFileVolumeList &volumeList) const;

  void updateThumbNailFiles(MultiFileVolumeList &volumeList,
                            const std::string &validCacheDir,
                            const std::string &validCacheFileName);
  
  static std::string createThumbFileName(const std::string &cacheDir,
                                         const std::string &cacheFileName,
                                         const size_t volumeIndex);
  
  static void removeThumbNail(const size_t volumeIndex, 
                              const std::string& validCacheDir, 
                              const std::string& validCacheFileName);

  static void removeThumbNails(const size_t numVolumes, 
                               const std::string& validCacheDir, 
                               const std::string& validCacheFileName);

  void updateVolumeListView(const MultiFileVolumeList &volumeList,
                            size_t subSetStart=0u,
                            size_t subSetEnd=std::string::npos);

  const BoolField &getUseThumbNailsField() const;
  
  static void replaceNonTableViewChars(const std::string& columnSubStr, std::string &correctedStr);
 
protected:
  
  struct _ColumnNameHeadValue {
    std::string name;

    std::string head;

    std::string value;
  };
  
  typedef std::vector<std::vector<_ColumnNameHeadValue> > _ColumnNameHeadValueVector;

  void        _checkIdxSortTagValue() const;

  std::string _getUserTagVal(DCMTree::Const_TreePtr tree,
                             size_t idx,
                             bool useNumericTagValueSorting) const;

  void        _appendTableColumn(const size_t               &volumeIdx,
                                 DCMTree::Const_TreePtr     tree,
                                 size_t                     &descIdx,
                                 bool                       isFirst,
                                 const std::string          &userVal,
                                 bool                       isTagValue,
                                 _ColumnNameHeadValueVector &tableColumns) const;

  std::vector<size_t> _determineTableColumnOrder() const;

  void _buildTableString(const _ColumnNameHeadValueVector &tableColumns,
                         bool showDots,
                         std::string &tableString) const;

  StringField *_volumeListViewFld;

  EnumField   *_sortModeFld;

  BoolField   *_sortUpwardsFld;

  StringField *_idxSortTagValueFld;

  BoolField   *_useNumericTagValueSortingFld;

  IntField    *_thumbNailsExtFld;

  NotifyField *_updateThumbNailsFld;

  BoolField   *_useThumbNailsField;

  StringField *_userColumnTagFld[3];

  StringField *_columnConfigFld;

  EnumField   *_iconBuildModeFld;

  class DirectDicomImportColumnDesc {
    public:
      std::string fieldIdName;
  
      DCMTree::RawTagId rawTagId;
  
      std::string headInfo;

      inline DirectDicomImportColumnDesc(const std::string &fldName, DCMTree::RawTagId id, const std::string&info):
        fieldIdName(fldName), 
        rawTagId(id), 
        headInfo(info){}

      inline DirectDicomImportColumnDesc(const DirectDicomImportColumnDesc&orig){ *this = orig; }

      inline DirectDicomImportColumnDesc &operator=(const DirectDicomImportColumnDesc&orig){
        if (this != &orig){
          fieldIdName = orig.fieldIdName;
          rawTagId    = orig.rawTagId;
          headInfo    = orig.headInfo;
        }
        return *this;
      }
  
    private:
      DirectDicomImportColumnDesc();
  };

  std::vector<DirectDicomImportColumnDesc> _columnDescs;
};
 
ML_END_NAMESPACE