mlDICOMCachedIOTreeCacheMap.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLDICOMCachedIOSystem.h"
#include <mlTypeDefs.h>
 
#include <FMEThirdPartyWarningsDisable.h>
#include <list>
#include <map>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
 
#include "mlDICOMCachedIOFileHandle.h"
#include "mlDICOMCachedIOTreeCacheMapEntry.h"
#include "mlDICOMCachedIOTreeCacheSingleMFMapEntry.h"
 
// Forwards
class MLDICOMCachedIODCMTreeLoaderPlugin;
class MLDICOMCachedIODCMTreeWriterPlugin;
namespace ML_NAMESPACE {
  class IntField;
  class DicomMessageCollector;
};

class MLDICOMCachedIO_EXPORT MLDICOMCachedIOTreeCacheMap 
{
public:
  MLDICOMCachedIOTreeCacheMap();

  ~MLDICOMCachedIOTreeCacheMap();
  
  MLint flush(const MLint maxBytes, const bool flushAll=false);

  MLint flush();

  void flushSingleFrameCache();
  
  MLint getNumFlushedBytes() const;
  
  void resetNumFlushedBytes();
  
  MLint  getMaxNumBytes() const;
  
  void setMaxNumMegaBytes(MLint maxNumMegaBytes);
  
  MLint getMaxNumMegaBytes() const;
  
  ML_NAMESPACE::IntField& getMaxNumMegaBytesFld();
  
  MLint getTotalNumberOfBytes() const;

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

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

  MLErrorCode loadDCMTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                          DCMTree::TreePtr                            &treePtr,
                          ML_NAMESPACE::DicomMessageCollector         &dcmMsgCollector);
  
  MLErrorCode saveDCMTree(DCMTree::Const_TreePtr                      dcmTree,
                          const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle);
  
  void removeAssociatedEntries(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle);

  inline std::vector< MLDICOMCachedIODCMTreeLoaderPlugin *>& getTreeLoaderPlugins() { return _treeLoaderPlugins; }

  inline const std::vector< MLDICOMCachedIODCMTreeLoaderPlugin* >& getConstTreeLoaderPlugins() const { return _treeLoaderPlugins; }

  inline std::vector< MLDICOMCachedIODCMTreeWriterPlugin* >& getTreeWriterPlugins() { return _treeWriterPlugins; }

  inline const std::vector< MLDICOMCachedIODCMTreeWriterPlugin*>& getConstTreeWriterPlugins() const { return _treeWriterPlugins; }

  void clear();
  
protected:
  MLErrorCode _addDCMTree(const ML_NAMESPACE::DICOMCachedIOFileHandle &fileHandle,
                          DCMTree::TreePtr                            &treePtr);
 

  std::map< ML_NAMESPACE::DICOMCachedIOFileHandle, 
            MLDICOMCachedIOTreeCacheMapEntry> _cache;

  std::map< ML_NAMESPACE::DICOMCachedIOFileHandle, 
            MLDICOMCachedIOTreeCacheSingleMFMapEntry> _singleFrameCache;

  std::list<ML_NAMESPACE::DICOMCachedIOFileHandle> _recentlyCached;

  MLint _totalNumBytes;

  MLint _numFlushedBytes;

  ml::IntField *_limitInMegaBytesFld;
  
  std::vector< MLDICOMCachedIODCMTreeLoaderPlugin *> _treeLoaderPlugins;
  
  std::vector< MLDICOMCachedIODCMTreeWriterPlugin *> _treeWriterPlugins;
};