COMP: Forgot to change string to TagKey...

[gdcm.git] / src / gdcmSerieHelper.h

diff --git a/src/gdcmSerieHelper.h b/src/gdcmSerieHelper.h
index deb2ac71c3e0d71c1bfa7f6328cf0ed9b4da0343..099203d07096bb6c4cbc2b6335d5ff80cfd788fa 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/02/05 02:43:06 $
-  Version:   $Revision: 1.5 $
+  Date:      $Date: 2005/07/11 15:29:04 $
+  Version:   $Revision: 1.11 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,7 +28,7 @@
 namespace gdcm 
 {
 class File;
-typedef std::vector<File* > GdcmFileList;
+typedef std::vector<File* > FileList;
 
 //-----------------------------------------------------------------------------
 /**
@@ -36,43 +36,51 @@ typedef std::vector<File* > GdcmFileList;
  * - 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 'Coherent Files' list (coherent : same Serie UID)
- *   It allows to sort any of the Coherent File list on the image postion
+ *   It allows to sort any of the Coherent File list on the image position
  */
 class GDCM_EXPORT SerieHelper 
 {
 public:
-   typedef std::map<std::string, GdcmFileList *> CoherentFileListmap;
-   typedef std::vector<File* > GdcmFileVector;
+   typedef std::map<std::string, FileList *> CoherentFileListmap;
+   typedef std::vector<File* > FileVector;
 
    SerieHelper();
    ~SerieHelper();
-   void Print(std::ostream &os = std::cout, std::string const & indent = "" );
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
 
    /// \todo should return bool or throw error ?
    void AddFileName(std::string const &filename);
    void SetDirectory(std::string const &dir, bool recursive=false);
-   void OrderGdcmFileList(GdcmFileList *CoherentGdcmFileList);
+   void OrderFileList(FileList *coherentFileList);
    
    /// \brief Gets the FIRST *coherent* File List.
    ///        Deprecated; kept not to break the API
-   /// \note Caller must call OrderGdcmFileList first
+   /// \note Caller must call OrderFileList first
    /// @return the (first) *coherent* File List
-   const GdcmFileList &GetGdcmFileList() { return
-                       *CoherentGdcmFileListHT.begin()->second; }
+   const FileList &GetFileList() { return *CoherentFileListHT.begin()->second; }
+  
+   FileList *GetFirstCoherentFileList();
+   FileList *GetNextCoherentFileList();
+   FileList *GetCoherentFileList(std::string serieUID);
+
+   /// All the following allow user to restrict DICOM file to be part
+   /// of a particular serie
+   void AddRestriction(TagKey const &key, std::string const &value);
   
-   GdcmFileList *GetFirstCoherentFileList();
-   GdcmFileList *GetNextCoherentFileList();
-   GdcmFileList *GetCoherentFileList(std::string SerieUID);
 
 private:
-   bool ImagePositionPatientOrdering(GdcmFileList *CoherentGdcmFileList);
-   bool ImageNumberOrdering(GdcmFileList *CoherentGdcmFileList);
-   bool FileNameOrdering(GdcmFileList *CoherentGdcmFileList);
+   bool ImagePositionPatientOrdering(FileList *coherentFileList);
+   bool ImageNumberOrdering(FileList *coherentFileList);
+   bool FileNameOrdering(FileList *coherentFileList);
    
    static bool ImageNumberLessThan(File *file1, File *file2);
    static bool FileNameLessThan(File *file1, File *file2);
-   CoherentFileListmap CoherentGdcmFileListHT;
+   CoherentFileListmap CoherentFileListHT;
    CoherentFileListmap::iterator ItListHt;
+
+   typedef std::pair<TagKey, std::string> Rule;
+   typedef std::vector<Rule> SerieRestrictions;
+   SerieRestrictions Restrictions;
 };
 
 } // end namespace gdcm