#3185 creaImageIO Feature New Normal - Clean code

[creaImageIO.git] / src / creaImageIOMultiThreadImageReader.h

diff --git a/src/creaImageIOMultiThreadImageReader.h b/src/creaImageIOMultiThreadImageReader.h
index 3c4da098f2c3141ec156bdd07a9b018afc687bfb..a49b57fddd665c199a11991d00aedb440afe9cef 100644 (file)
--- a/src/creaImageIOMultiThreadImageReader.h
+++ b/src/creaImageIOMultiThreadImageReader.h
@@ -1,3 +1,30 @@
+/*
+# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
+#                        pour la Santé)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+# Previous Authors : Laurent Guigues, Jean-Pierre Roux
+# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+#
+#  This software is governed by the CeCILL-B license under French law and 
+#  abiding by the rules of distribution of free software. You can  use, 
+#  modify and/ or redistribute the software under the terms of the CeCILL-B 
+#  license as circulated by CEA, CNRS and INRIA at the following URL 
+#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+#  or in the file LICENSE.txt.
+#
+#  As a counterpart to the access to the source code and  rights to copy,
+#  modify and redistribute granted by the license, users are provided only
+#  with a limited warranty  and the software's author,  the holder of the
+#  economic rights,  and the successive licensors  have only  limited
+#  liability. 
+#
+#  The fact that you are presently reading this means that you have had
+#  knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------
+*/
+
 #ifndef __creaImageIOThreadedImageReader_h_INCLUDED__
 #define __creaImageIOThreadedImageReader_h_INCLUDED__
 
@@ -9,9 +36,13 @@
 #include <wx/thread.h>
 #include <queue>
 
+
+
 namespace creaImageIO
 {
-
+       /**
+       * \ingroup IO
+       */
   //=====================================================================
   class ThreadedImageReader;
   class MultiThreadImageReader;
@@ -64,6 +95,8 @@ namespace creaImageIO
   //=====================================================================
   /// 
   /// TAKE CARE : For the moment it only supports a **SINGLE USER** 
+
+   ///Class that allows parallel lectures of several images
   class MultiThreadImageReader : public MultiThreadImageReaderUser
   {
   public:
@@ -88,7 +121,8 @@ namespace creaImageIO
                  int priority );
     
     /// Request the image "filename" immediately 
-    /// (no callback but image returned)
+       /// Blocks until image loaded
+    /// (no user callback but image returned)
     vtkImageData* GetImage(const std::string& filename);
 
     /// 
@@ -98,10 +132,14 @@ namespace creaImageIO
     void OnMultiThreadImageReaderEvent( const std::string& filename,
                                        EventType type,
                                        vtkImageData* image);
-    
+   
+    /// Function to read attributes for a file 
+       void getAttributes(const std::string filename, std::map <std::string , std::string> &infos, std::vector<std::string> i_attr);
+
   protected:
+         bool mDone;
     int GetMaximalPriorityWithoutLocking();
-    // 
+    ///Class that represents an image to be loaded
     class ImageToLoad
     {
     public:
@@ -132,6 +170,8 @@ namespace creaImageIO
       int& UnloadIndex() { return mUnloadIndex; }
       vtkImageData* GetImage() const { return mImage; }
       void SetImage( vtkImageData* i ) { mImage=i; }
+
+         std::map<std::string, std::string> getAttributes(const std::vector<std::string> i_attr);
     private:
       MultiThreadImageReaderUser* mUser;
       std::string mFilename;
@@ -204,7 +244,8 @@ namespace creaImageIO
                ImageToLoadPtrIndexer> mQueue;
 
     /// The type of list of threaded readers
-    typedef std::vector<ThreadedImageReader*> ThreadedImageReaderListType;
+       typedef std::vector<boost::shared_ptr<ThreadedImageReader> > ThreadedImageReaderListType;
+       //typedef std::vector<ThreadedImageReader* > ThreadedImageReaderListType;
     ThreadedImageReaderListType mThreadedImageReaderList;
     /// The number of currently running threaded readers
     int mNumberOfThreadedReadersRunning;