mlDICOMCachedIOTreeCache.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLDICOMCachedIOSystem.h"
#include "mlTypeDefs.h"
#include "mlFields.h"
 
// Include for FME_ML_DELETE
#include "mlErrorMacros.h"
 
ML_START_NAMESPACE
template<typename CT> class DICOMCachedIOFileHandleBase;


typedef DICOMCachedIOFileHandleBase<char> DICOMCachedIOFileHandle;
class DicomMessageCollector;
ML_END_NAMESPACE
 
// DICOM
#include <DCMTree_Lib.h>
 
// Forwards.
class MLDICOMCachedIOTreeCacheMap;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDICOMCachedIO_EXPORT MLDICOMCachedIOTreeCache {
 
  public:
  
    MLDICOMCachedIOTreeCache();
    MLDICOMCachedIOTreeCache(const MLDICOMCachedIOTreeCache&) = delete;
    MLDICOMCachedIOTreeCache& operator=(const MLDICOMCachedIOTreeCache&) = delete;
    ~ MLDICOMCachedIOTreeCache();
  
    
    //----------------------------------------------------------------------------------
    //----------------------------------------------------------------------------------
    
    MLint flush(const MLint maxBytes, const bool flushAll=false);
    
    MLint flush();
    
    void flushSingleFrameCache();
    
    void  setMaxNumBytes(MLint maxNumBytes);
    void  setMaxNumMegaBytes(MLint maxNumMegaBytes);
    
    MLint getMaxNumBytes() const ;
    
    MLint getMaxNumMegaBytes() const;

    MLint getTotalNumberOfBytes() const;
    
    ml::IntField& getMaxNumMegaBytesFld() const;
    
    void clear();
    
    MLint getNumFlushedBytes() const;
    
    void resetNumFlushedBytes();
    
    //----------------------------------------------------------------------------------
    //----------------------------------------------------------------------------------

    static MLDICOMCachedIOTreeCache singletonProxy();
   
    //----------------------------------------------------------------------------------
    //----------------------------------------------------------------------------------

    void storeSingleFrameTree(DCMTree::TreePtr                            singleFrameTree,
                              const ML_NAMESPACE::DICOMCachedIOFileHandle &origFileHandle,
                              size_t                                      frameIndex);
    
    //----------------------------------------------------------------------------------
    //----------------------------------------------------------------------------------

    MLErrorCode saveDCMTree(DCMTree::Const_TreePtr dcmTree,
                            const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle);

    MLErrorCode getCachedDCMTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                                 DCMTree::TreePtr                            &treePtr);

    void removeAssociatedEntries(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle);

    MLErrorCode loadDCMTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                            DCMTree::TreePtr                            &treePtr,
                            ML_NAMESPACE::DicomMessageCollector         &dcmMsgCollector);

    MLErrorCode loadConstantDCMTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                                    DCMTree::Const_TreePtr                      &treePtr,
                                    ML_NAMESPACE::DicomMessageCollector         &dcmMsgCollector);

    MLErrorCode loadSMFTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                            DCMTree::StructuredMFPtr                    &smfPtr,
                            ML_NAMESPACE::DicomMessageCollector         &dcmMsgCollector);
    
    MLErrorCode addDCMTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                           DCMTree::TreePtr                            &treePtr);
    
private:
  static MLDICOMCachedIOTreeCacheMap *_treeCachePtr;
  
  static MLuint                      _instanceCounter;
};