mlMultiFileVolumeList.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLMultiFileVolumeSystem.h"
#include <mlTypeDefs.h>
#include <FMEThirdPartyWarningsDisable.h>
#include <list>
#include <map>
#include <set>
#include <string>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
#include "mlMultiFileVolumeListSort.h"
#include "mlMultiFileVolumeListFind.h"
#include <mlDICOMCachedIOFileHandle.h>
 
ML_START_NAMESPACE
 
// Forwards internally used types.
class DicomMessageCollector;
class MultiFileVolume;
class ProgressLogger;
namespace DICOMTagTools{
  class ZTUIndex;
};
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
typedef std::multimap<unsigned int, std::string> TSearchTerm;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLMULTI_FILE_VOLUME_EXPORT MultiFileVolumeList : public std::vector<MultiFileVolume*> {
  public:

    typedef void ProgressCB(void  *usrData,
                            const std::string &info,
                            float state);

    typedef void RemoveUserFileCB(const size_t volumeIndex, 
                                  const std::string& validCacheDir, 
                                  const std::string& validCacheFileName);
 
    // Default constructor, deletes all MultiFileVolumes in its list.
    MultiFileVolumeList();

    virtual ~MultiFileVolumeList();

    MultiFileVolumeList(const MultiFileVolumeList &ref);

    MultiFileVolumeList &operator=(const MultiFileVolumeList &ref);

    void setUpIssues(const DicomMessageCollector *dcmMsgCollector = nullptr);

    std::string getIssues(const DicomMessageCollector *dcmMsgCollector = nullptr) const;

    void freeAllVolumes();

    bool equals(const MultiFileVolumeList &obj) const;

    void sortVolumes(MultiFileVolumeListSort::SortModes sortMode,
                     bool                               sortUpwards,
                     MLint                              rawTagId,
                     bool                               useNumericTagStringValueSorting);

    MultiFileVolume* findVolumeByInstanceUID(std::string sopClassUID, 
                                             std::string sopInstanceUID) const;

    bool findVolumesByCriteria(TSearchTerm searchTerm, 
                               std::vector<MLuint32>& outVolumeIds,
                               MultiFileVolumeListFind::BooleanOperation booleanOperation,
                               bool searchAnyValue) const;

    MLErrorCode appendToCache(const std::string &cacheDirPath,
                              std::string       &currCacheState,
                              bool               useRelativePaths,
                              const std::string &optionalFilePrefix="") const;

    MLErrorCode setFromString(const std::string      &state,
                              const std::string      &cacheDirPath,
                              ProgressCB              progressCB      = nullptr,
                              void                   *userData        = nullptr,
                              const float             startPercentage = 0.0f,
                              const float             percentageRange = 1.0f,
                              std::list<std::string> *cacheFileList   = nullptr,
                              DicomMessageCollector  *dcmMsgCollector = nullptr);
 
    //--------------------------------------------------
    //--------------------------------------------------

    static std::string getResultCacheFileName(const std::string  &fileNameInput,
                                              const std::string  &cachePathInput,
                                              std::string        &fileName,
                                              std::string        &cacheDirPath,
                                              const MLint        fileIndex=-1);

    static MLErrorCode clearResultCacheFiles(const std::string &fileNameInput,
                                             const std::string &cachePathInput,
                                             ProgressLogger    *progressLogger = nullptr,
                                             RemoveUserFileCB  userFileDeleter = nullptr);
    
    MLErrorCode loadResultCache(const std::string  &fileNameInput,
                                const std::string  &cachePathInput,
                                ProgressLogger     *progressLogger,
                                bool               &volumeListChanged,
                                ProgressCB         progressCallback,
                                void               *userData);

    MLErrorCode writeResultCache(const std::string  &fileNameInput,
                                 const std::string  &cachePathInput,
                                 const bool         useRelativePaths,
                                 const bool         writeSingleVolumeCaches,
                                 ProgressLogger     *progressLogger) const;

    MLErrorCode loadResultCacheIntoVolumeList(const std::string      &sourceFileName,
                                              const std::string      &cacheDirPath,
                                              bool                   *volumeListChanged = nullptr,
                                              ProgressCB             progressCB         = nullptr,
                                              void                   *userData          = nullptr,
                                              const float            startPercentage    = 0.0f,
                                              const float            percentageRange    = 1.0f,
                                              std::list<std::string> *cacheFileList     = nullptr,
                                              DicomMessageCollector  *dcmMsgCollector   = nullptr);

    MLErrorCode loadMultiFileVolumeListCache(const std::string       &fileName,
                                             bool                    *volumeListChanged = nullptr,
                                             ProgressCB              progressCB         = nullptr,
                                             void                    *userData          = nullptr,
                                             const float             startPercentage    = 0.0f,
                                             const float             percentageRange    = 1.0f,
                                             std::list<std::string>  *cacheFileList     = nullptr);

    MLErrorCode clearResultFiles(ProgressLogger *progressLogger = nullptr) const;
 
        
    bool        searchFrameWithSOPInstanceUID(const std::string                   &sopInstanceUID,
                                              DICOMCachedIOFileHandle             &foundHandle,
                                              DICOMTagTools::ZTUIndex             &ztuPosition,
                                              MultiFileVolumeList::const_iterator &volumeIt,
                                              bool                                forceSearchInEnhancedHandles,
                                              bool                                alsoSearchInSMFTrees,
                                              DicomMessageCollector               &dcmMsgCollector) const;

    bool        searchFrameWithValueInTag(unsigned int                        tagId,
                                          const std::string                   &tagValue,
                                          DICOMCachedIOFileHandle             &foundHandle,
                                          DICOMTagTools::ZTUIndex             &ztuPosition,
                                          MultiFileVolumeList::const_iterator &volumeIt,
                                          bool                                forceSearchInEnhancedHandles,
                                          bool                                alsoSearchInSMFTrees,
                                          DicomMessageCollector               &dcmMsgCollector) const;

    std::vector<MultiFileVolumeList::const_iterator> searchVolumesWithFramesWithValueInTag(unsigned int          tagId,
                                                                                           const std::string     &tagValue,
                                                                                           bool                  forceSearchInEnhancedHandles,
                                                                                           bool                  alsoSearchInSMFTrees,
                                                                                           DicomMessageCollector &dcmMsgCollector) const;

    std::set<size_t> searchVolumeIndexesWithValueInTag(unsigned int          tagId,
                                                       const std::string     &tagValue,
                                                       bool                  forceSearchInEnhancedHandles,
                                                       bool                  alsoSearchInSMFTrees,
                                                       DicomMessageCollector &dcmMsgCollector) const;
    
  protected:
    MLErrorCode _setFromMultiCacheFile(const std::string      &state,
                                       const std::string      &cacheDirPath,
                                       ProgressCB              progressCB      ,
                                       void                   *userData        ,
                                       const float             startPercentage ,
                                       const float             percentageRange ,
                                       std::list<std::string> *cacheFileList   ,
                                       size_t                 &readPos,
                                       DicomMessageCollector  *dcmMsgCollector);
};

typedef MultiFileVolumeList DirectDicomImportOutVolumeList;
 
ML_END_NAMESPACE