* Preparation of writing a gdcmHeader iterator: generalisation of gdcmTagKey

[gdcm.git] / src / gdcmDicomDirStudy.h

diff --git a/src/gdcmDicomDirStudy.h b/src/gdcmDicomDirStudy.h
index 4c69b7b0a7670934fca90b526bb2bced3a0fe9c8..8c3c8d3e4fa2919fe38b3a237ab39c15d3cdaeb1 100644 (file)
--- a/src/gdcmDicomDirStudy.h
+++ b/src/gdcmDicomDirStudy.h
@@ -1,5 +1,21 @@
-// gdcmDicomDirStudy.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDirStudy.h,v $
+  Language:  C++
+  Date:      $Date: 2004/08/26 15:29:52 $
+  Version:   $Revision: 1.7 $
+                                                                                
+  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.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMDICOMDIRSTUDY_H
 #define GDCMDICOMDIRSTUDY_H
 
@@ -10,17 +26,37 @@
 typedef std::list<gdcmDicomDirSerie *> ListDicomDirSerie;
 
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmDicomDirStudy : public gdcmObject {
+class GDCM_EXPORT gdcmDicomDirStudy : public gdcmObject
+{
 public:
-   gdcmDicomDirStudy(ListTag::iterator begin,ListTag::iterator end);
-   ~gdcmDicomDirStudy(void);
+   gdcmDicomDirStudy(gdcmSQItem *s, TagDocEntryHT *ptagHT); 
+   gdcmDicomDirStudy(TagDocEntryHT *ptagHT); 
 
-   virtual void Print(std::ostream &os = std::cout);
+   ~gdcmDicomDirStudy();
 
-   inline ListDicomDirSerie &GetDicomDirSeries() {return series;};
-   inline void AddDicomDirSerie(gdcmDicomDirSerie *obj) {series.push_back(obj);};
+   virtual void Print(std::ostream &os = std::cout);
+   virtual void Write(FILE *fp, FileType t);
+/**
+ * \ingroup gdcmDicomDirStudy
+ * \brief   returns the SERIE chained List for this STUDY.
+ */
+   ListDicomDirSerie &GetDicomDirSeries() { return series; };
+/**
+ * \ingroup gdcmDicomDirStudy
+ * \brief   adds the passed SERIE to the SERIE chained List for this STUDY.
+ */ 
+   void AddDicomDirSerie(gdcmDicomDirSerie *obj) { series.push_back(obj); };
 
+/**
+ * \ingroup gdcmDicomDirStudy
+ * \brief   TODO
+ */ 
+   gdcmDicomDirSerie* NewSerie();
+    
 private:
+/**
+* \brief chained list of DicomDirSeries (to be exploited recursively)
+*/ 
    ListDicomDirSerie series;
 };