STYLE: Cleanup the Mac address stuff (1st pass)

[gdcm.git] / src / gdcmSQItem.h

diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index 22eaedb32a1e7cda2037a576591a7bed466ac93c..58d5e86f1424217294742826d0cb86936c00a9d2 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/28 03:10:58 $
-  Version:   $Revision: 1.22 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.31 $
                                                                                 
   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 
 {
@@ -30,32 +31,36 @@ class DocEntry;
 //-----------------------------------------------------------------------------
 typedef std::list<DocEntry *> ListDocEntry;
 //-----------------------------------------------------------------------------
+/**
+ * \brief a SeqEntry is composed by a set of SQItems.
+ *        Each SQItem is composed by a set of DocEntry
+ *        A DocEntry may be a SeqEntry
+ *        ... and so forth 
+ */ 
 class GDCM_EXPORT SQItem : public DocEntrySet 
 {
 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; };
+   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 *GetDocEntry(uint16_t group, uint16_t element);
    
-   bool SetEntryByNumber(std::string const & val, uint16_t group, 
-                                                  uint16_t element);
+   bool SetEntry(std::string const &val, uint16_t group, 
+                                         uint16_t element);
     
-   std::string GetEntryByNumber(uint16_t group, uint16_t element);
+   std::string GetEntry(uint16_t group, uint16_t element);
 
    /// \brief   returns the ordinal position of a given SQItem
    int GetSQItemNumber() { return SQItemNumber; };
@@ -63,28 +68,32 @@ public:
    /// \brief   Sets the ordinal position of a given SQItem
    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
 
-   /// Accessor on \ref SQDepthLevel.
+   ///  \brief Accessor on \ref SQDepthLevel.
    int GetDepthLevel() { return SQDepthLevel; }
                                                                                 
-   /// Accessor on \ref SQDepthLevel.
+   ///  \brief Accessor on \ref SQDepthLevel.
    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
-   /// Accessor on \ref BaseTagKey.
-   void SetBaseTagKey( BaseTagKey const & key ) { BaseTagKeyNested = key; }
+   ///  \brief Accessor on \ref BaseTagKey.
+   void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
 
-   /// Accessor on \ref BaseTagKey.
-   BaseTagKey const & GetBaseTagKey() const { return BaseTagKeyNested; }
+   ///  \brief Accessor on \ref BaseTagKey.
+   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,
+   /// \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:
 
@@ -99,10 +108,8 @@ private:
    ///        with this BaseTagKey.
    BaseTagKey BaseTagKeyNested;
 
- 
    /// \brief SQ Item ordinal number 
    int SQItemNumber;
-
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------