STYLE: correct typo in comment

[gdcm.git] / src / gdcmSerieHeader.h

diff --git a/src/gdcmSerieHeader.h b/src/gdcmSerieHeader.h
index fe95a31bb8876393f53caf8de9ddd91af0f235b1..b6a8a76da083d6e308a6452055b68c6027611e10 100644 (file)
--- a/src/gdcmSerieHeader.h
+++ b/src/gdcmSerieHeader.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHeader.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 20:16:58 $
-  Version:   $Revision: 1.2 $
+  Date:      $Date: 2005/01/14 21:30:53 $
+  Version:   $Revision: 1.6 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -26,34 +26,29 @@ namespace gdcm
 {
 class Header;
 //-----------------------------------------------------------------------------
-/*
- * \defgroup SerieHeader
+/**
+ * \ingroup SerieHeader
  * \brief  
- *
  * - This class should be used for a stack of 2D dicom images.
  * - For a multiframe dicom image better use directly SerieHeader
 */
 class GDCM_EXPORT SerieHeader 
 {
 public:
+   typedef std::list<Header* > GdcmHeaderList;
+
     SerieHeader();
     ~SerieHeader();
 
    /// \todo should return bool or throw error ?
-   void AddFileName(std::string const & filename);
-   void AddGdcmFile(Header *file);
-   void SetDirectory(std::string const & dir);
+   void AddFileName(std::string const &filename);
+   void SetDirectory(std::string const &dir);
    void OrderGdcmFileList();
    
-   /// \warning Assumes all elements in the list have the same global infos.
-   ///          Assumes the list is not empty.
-   Header* GetGdcmHeader() { return CoherentGdcmFileList.front(); }
-
-   typedef std::list<Header* > GdcmHeaderList;
-
    /// \brief Gets the *coherent* File List
    /// @return the *coherent* File List
-   const GdcmHeaderList& GetGdcmFileList() { return CoherentGdcmFileList; }
+   /// Caller must call OrderGdcmFileList first
+   const GdcmHeaderList &GetGdcmFileList() { return CoherentGdcmFileList; }
 
 private:
    bool ImagePositionPatientOrdering();
@@ -61,6 +56,9 @@ private:
    bool FileNameOrdering();
    
    GdcmHeaderList CoherentGdcmFileList;
+   /// Ref to the current Serie Instance UID to avoid mixing two series
+   /// within the same directory
+   std::string    CurrentSerieUID;
 };
 
 } // end namespace gdcm