Coding Style + Doxygenation

[gdcm.git] / src / gdcmSQItem.h

diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index fc5e755210ecf1e2069f9400ce22cb6f5c924e02..9bce85dd5311b1f27bbdf4395d5d5a5de6e350fc 100644 (file)
--- a/src/gdcmSQItem.h
+++ b/src/gdcmSQItem.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/25 03:35:20 $
-  Version:   $Revision: 1.21 $
+  Date:      $Date: 2005/01/06 20:03:28 $
+  Version:   $Revision: 1.28 $
                                                                                 
   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 "gdcmElementSet.h"
 
 #include <list>
+#include <fstream>
 
 namespace gdcm 
 {
@@ -36,23 +37,24 @@ public:
    SQItem(int depthLevel);
    ~SQItem();
 
-   void Print(std::ostream &os = std::cout); 
-   void Write(std::ofstream *fp, FileType filetype);
+   virtual void Print(std::ostream &os = std::cout); 
+   void WriteContent(std::ofstream *fp, FileType filetype);
 
    /// \brief   returns the DocEntry chained List for this SQ Item.
    ListDocEntry const &GetDocEntries() const { return DocEntries; };
    
    /// \brief   adds the passed DocEntry to the DocEntry chained List for
    /// this SQ Item.      
-   void AddDocEntry(DocEntry *e) { DocEntries.push_back(e); };
-
-   virtual bool AddEntry(DocEntry *Entry); // add to the List
+   bool AddEntry(DocEntry *Entry); // add to the List
+   bool RemoveEntry(DocEntry *EntryToRemove);
+   bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
   
    DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
    // FIXME method to write
-   //DocEntry *GetDocEntryByName  (std::string Name);
+   //DocEntry *GetDocEntryByName(std::string Name);
    
-   bool SetEntryByNumber(std::string const & val, uint16_t group, uint16_t element);                   
+   bool SetEntryByNumber(std::string const &val, uint16_t group, 
+                                                 uint16_t element);
     
    std::string GetEntryByNumber(uint16_t group, uint16_t element);
 
@@ -69,21 +71,25 @@ public:
    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
    /// Accessor on \ref BaseTagKey.
-   void           SetBaseTagKey( BaseTagKey const & key ) { BaseTagKeyNested = key; }
+   void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
 
    /// Accessor on \ref BaseTagKey.
-   BaseTagKey const & GetBaseTagKey() const { return BaseTagKeyNested; }
+   BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
 
+   void Initialize();
+   DocEntry *GetNextEntry();
 
 protected:
 // Variables that need to be access in subclasses
 
-   /// \brief chained list of (Elementary) Doc Entries
+   /// \brief Chained list of (Elementary) Doc Entries
    ListDocEntry DocEntries;
+   /// Chained list iterator, used to visit the TagHT variable
+   ListDocEntry::iterator ItDocEntries;
    
    ///\brief pointer to the HTable of the Document,
    ///       (because we don't know it within any DicomDirObject nor any SQItem)
-   TagDocEntryHT *PtagHT;
+   // TagDocEntryHT *PtagHT;
 
 private:
 
@@ -98,10 +104,8 @@ private:
    ///        with this BaseTagKey.
    BaseTagKey BaseTagKeyNested;
 
- 
    /// \brief SQ Item ordinal number 
    int SQItemNumber;
-
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------