:ENH: Adding the 16bits ijg jpeg lib. This is only the lossless part since there...

[gdcm.git] / src / gdcmHeaderHelper.h

diff --git a/src/gdcmHeaderHelper.h b/src/gdcmHeaderHelper.h
index 9aa136ccad3c35c78fa2655b4a4a2399ba7a6bbc..5dc42bfc916e123e479e13b4da4c32380f6fc559 100644 (file)
--- a/src/gdcmHeaderHelper.h
+++ b/src/gdcmHeaderHelper.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmHeaderHelper.h,v $
   Language:  C++
-  Date:      $Date: 2004/06/21 04:18:26 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2004/10/12 04:35:46 $
+  Version:   $Revision: 1.22 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
@@ -21,44 +21,48 @@
 
 #include "gdcmHeader.h"
 
-//-----------------------------------------------------------------------------
-
-class GDCM_EXPORT gdcmHeaderHelper : public gdcmHeader
+namespace gdcm 
 {
-};
 
+//-----------------------------------------------------------------------------
 /*
- * \defgroup gdcmSerieHeader
+ * \defgroup SerieHeader
  * \brief  
  *
  * - This class should be used for a stack of 2D dicom images.
- * - For a multiframe dicom image better use directly gdcmHeaderHelper
+ * - For a multiframe dicom image better use directly HeaderHelper
 */
-class GDCM_EXPORT gdcmSerieHeader {
+class GDCM_EXPORT SerieHeader 
+{
 public:
-    gdcmSerieHeader() {};
-    ~gdcmSerieHeader();
+    SerieHeader();
+    ~SerieHeader();
 
-   void AddFileName(std::string filename); //should return bool or throw error ?
-   void AddGdcmFile(gdcmHeader *file);
-   void SetDirectory(std::string dir);
+   /// \todo should return bool or throw error ?
+   void AddFileName(std::string const & filename);
+   void AddGdcmFile(Header *file);
+   void SetDirectory(std::string const & dir);
    void OrderGdcmFileList();
    
-   inline gdcmHeader *GetGdcmHeader()
-   {
-      //Assume all element in the list have the same global infos
-      return CoherentGdcmFileList.front();
-   }
-   
-   std::list<gdcmHeader*>& GetGdcmFileList();
+   /// \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; }
 
 private:
    bool ImagePositionPatientOrdering();
    bool ImageNumberOrdering();
    bool FileNameOrdering();
    
-   std::list<gdcmHeader*> CoherentGdcmFileList;
+   GdcmHeaderList CoherentGdcmFileList;
 };
 
+} // end namespace gdcm
+
 //-----------------------------------------------------------------------------
 #endif