mlFileListToolsFileList.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
#pragma once
 
#include "MLFileListToolsSystem.h"
 
// For input filtering and file attributes.
#include "mlFileListToolsFileAttribute.h"
#include "mlFileListFilterPluginBase.h"
 
// Used for caching pointers to already loaded DICOM trees.
#include "mlDICOMCachedIOProxies.h"
 
// Logging and updating class.
#include <mlProgressLogger.h>
 
// ML includes
#include <mlTypeDefs.h>
#include <FMEThirdPartyWarningsDisable.h>
#include <map>
#include <string>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
 
// DCMTree tree prototypes.
#include "DCMTree_Lib.h"
 
 
ML_START_NAMESPACE
 
namespace FileListTools {
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLFILE_LIST_TOOLS_EXPORT FileList
{
public:
 
  typedef FileListFilterPluginBase::FileAttributeMap    FileAttributeMap;
 
  typedef std::map< std::string, const FileAttribute* > FileAttributeMapReferenced;
 
  typedef std::vector< FileAttributeMapReferenced >     FileAttributeMaps;
 
 
  FileList(const FileListFilterPluginBase *filterPlugin);
 
  FileList(const FileList &fileList, size_t fileListIdx);
 
  virtual ~FileList(){};
 
  const FileListFilterPluginBase *getConstFilterPlugin() const    { return _filterPlugin; }
 
  void                     reset()                                { _fileAttributeMap.clear(); _groupedFileAttributeMaps.clear(); }
 
  FileAttributeMap         &getFileAttributeMap()                 { return _fileAttributeMap; }
 
  const FileAttributeMap   &getFileAttributeMap()          const  { return _fileAttributeMap; }
 
  const FileAttributeMaps  &getGroupedFileAttributeMaps() const   { return _groupedFileAttributeMaps; }
 
  FileAttribute            &getAttributesForFile(const std::string &fileName);
 
  const FileAttribute     *getAttributesForFile(const std::string &fileName) const;
 
  std::vector<std::string> getFileNameList(bool onlyPassed, MLuint32 fileTypeMaskMask, MLuint32 noFileTypeMaskMask) const;
 
  enum {
    CopyFullFunctionalGroupSequences = 1 
  };
  
  void setDicomImportFlags(MLint64 flags);
 
  MLint64 getDicomImportFlags() const;
  
  virtual bool             setUpFilesToImport(ProgressLogger                 *progressLogger,
                                              const std::string              &frameSourcesDir,
                                              const std::vector<std::string> &suppressedFilesAndSuffixes,
                                              const std::vector<std::string> &explicitFileTypes,
                                              const std::vector<std::string> &additionalFiles,
                                              bool                           recursively,
                                              bool                           decomposeMultiFrames,
                                              float                          progressMinimum,
                                              float                          progressMaximum,
                                              DicomMessageCollector          &dcmMsgCollector);
 
protected:
 
  // Methods:
 
  bool                  _doMultiFrameDecomposition(FileAttribute         &fileAttributes,
                                                   DicomMessageCollector &dcmMsgCollector);
 
        // Always skip further handling below if a DCM/Tiff was detected.
  virtual void           _addFile(const std::string              &fullFileNamePathToAdd,
                                  const std::vector<std::string> &suppressedFilesAndSuffixes,
                                  const std::vector<std::string> &explicitFileTypes,
                                  bool                           decomposeMultiFrames,
                                  bool                           checkForTiffDcm,
                                  DicomMessageCollector          &dcmMsgCollector);
 
  void                   _updateLabelConfigGroups();
 
  MLDICOMCachedIOProxies          _cacheProxies;
                                  
  // Members:
  FileAttributeMap                _fileAttributeMap;
 
  FileAttributeMaps               _groupedFileAttributeMaps;
 
  const FileListFilterPluginBase *_filterPlugin;
 
  MLint64                         _dicomImportFlags;
};
 
}; // end namespace FileListTools.
 
typedef FileListTools::FileList DirectDicomImportFileList; 
 
ML_END_NAMESPACE