Doxygenation

[gdcm.git] / src / gdcmSerieHelper.h

diff --git a/src/gdcmSerieHelper.h b/src/gdcmSerieHelper.h
index 6b91c5bbf98b7a1346465d1b717636bdb9074605..9264eb18677a8b0a7401d2b51719c143ea0c97f9 100644 (file)
--- a/src/gdcmSerieHelper.h
+++ b/src/gdcmSerieHelper.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/23 15:04:26 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2005/11/21 09:46:27 $
+  Version:   $Revision: 1.29 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -22,6 +22,7 @@
 #include "gdcmCommon.h" 
 #include "gdcmTagKey.h" 
 #include "gdcmDebug.h"  // for LEGACY
+#include "gdcmRefCounter.h"
  
 #include <vector>
 #include <iostream>
@@ -31,7 +32,6 @@ namespace gdcm
 {
 class File;
 
-
    typedef std::vector<File* > FileList;
    
    /// \brief XCoherent stands for 'Extra Coherent', 
@@ -45,18 +45,21 @@ class File;
 //-----------------------------------------------------------------------------
 /**
  * \brief  
- * - This class should be used for a stack of 2D dicom images.
- *   It allows to explore (recursively or not) a directory and 
+ *  This class should be used for a stack of 2D dicom images.
+ *
+ *   - It allows to explore (recursively or not) a directory and 
  *   makes a set of 'Single SerieUID Filesets' 
- *   It allows :
- *   - to sort any of the 'Single SerieUID Fileset' on the image position.
- *   - to split any of the Single SerieUID Filesets (better use this name than
- *   'Coherent File List' : it's NOT a std::list, files are NOT coherent ...)
+ *   - It allows :
+ *   - - to sort any of the 'Single SerieUID Fileset' on the image position.
+ *   - - to split any of the Single SerieUID Filesets (better use this name than
+ *   'CoherentFileList' : it's NOT a std::list, files are NOT coherent ...)
  *    into several XCoherent Filesets 
  *   XCoherent stands for 'Extra Coherent' (same orientation, or same position)
  */
-class GDCM_EXPORT SerieHelper 
+class GDCM_EXPORT SerieHelper  : public RefCounter
 {
+   gdcmTypeMacro(SerieHelper);
+   
 public:
    /// SingleSerieUIDFileSetmap replaces the former CoherentFileListmap
    /// ( List were actually std::vectors, and wher no coherent at all :
@@ -65,9 +68,10 @@ public:
 
    typedef std::vector<File* > FileVector;
 
-  
-   SerieHelper();
-   ~SerieHelper();
+/// \brief Constructs a SerieHelper with a RefCounter
+    static SerieHelper *New() {return new SerieHelper();}
+     
+   virtual ~SerieHelper();
    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
 
    /// \todo should return bool or throw error ?
@@ -92,12 +96,12 @@ public:
    FileList *GetFirstSingleSerieUIDFileSet();
    FileList *GetNextSingleSerieUIDFileSet();
    FileList *GetSingleSerieUIDFileSet(std::string serieUID);
-
+   /// brief returns the 'Series Instance UID' Single SerieUID FileSet
+   std::string GetCurrentSerieUIDFileSetUID()
+                             { return  (*ItFileSetHt).first; }
    /// All the following allow user to restrict DICOM file to be part
    /// of a particular serie
-   GDCM_LEGACY( void AddRestriction(TagKey const &key, std::string const &value) );
-   void AddRestriction(uint16_t group, uint16_t elem, 
-                       std::string const &value, int op);
+   void AddRestriction(TagKey const &key, std::string const &value, int op);
  
 /**
  * \brief Sets the LoadMode as a boolean string. 
@@ -124,6 +128,9 @@ public:
    XCoherentFileSetmap SplitOnPosition(FileList *fileSet); 
    XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
                                                uint16_t group, uint16_t elem);
+protected :
+   SerieHelper();
+   
 private:
    void ClearAll();
    bool UserOrdering(FileList *fileSet);